Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/esamattis/npm-release
Github action for npm (pre)releases
https://github.com/esamattis/npm-release
github-action
Last synced: 4 months ago
JSON representation
Github action for npm (pre)releases
- Host: GitHub
- URL: https://github.com/esamattis/npm-release
- Owner: esamattis
- License: mit
- Created: 2019-09-22T14:11:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:10:03.000Z (about 2 years ago)
- Last Synced: 2024-08-02T07:02:21.133Z (6 months ago)
- Topics: github-action
- Language: TypeScript
- Homepage:
- Size: 834 KB
- Stars: 15
- Watchers: 3
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Publish npm (pre)releases
README
# Github action to make npm (pre)releases
## Prerelease
To make npm prereleases on git push to master add
`.github/workflows/prerelease.yml`
```yaml
on:
push:
branches:
- master
jobs:
prerelease:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Make prerelease to npm
uses: epeli/npm-release@v1
with:
type: prerelease
token: ${{ secrets.NPM_TOKEN }}
```
This bumbs the patch version and makes new release with a `next` tag. The
versions will look like `1.0.1-dev.c7f620550` where is the suffix is the git
revision the release was made from.
## Stable release
To make a stable npm release when a Github release is made add
`.github/workflows/release.yml`
```yaml
on:
release:
types: [published]
jobs:
prerelease:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Make stable release to npm
uses: esamatti/npm-release@v2
with:
type: stable
token: ${{ secrets.NPM_TOKEN }}
```
This will just do the release using the version in `package.json`.
To easily make a Github release with a git tag you can use [np][] with
`--no-publish` flag.
```
npx np --no-publish
```
[np]: https://github.com/sindresorhus/np
## Examples
react-bemed
- https://github.com/epeli/react-bemed/tree/master/.github/workflows
- https://www.npmjs.com/package/react-bemed
- Checkout the "Versions" tab
## Running tests and building
If you need to run build and/or tests before the release you can add a workflow step for it or just
add it to the `prepublishOnly` script in `package.json`.