GitHub Action
publish node package action
v2.2.2
Latest version
Publish a NodeJS package to NPM Repository or GitHub Packages
PreRequirements
- Make sure you've stored a NPM Classic Token (an "Automation" token) as a secret in your repository. You can generate one at https://www.npmjs.com/settings/your-username/tokens.
- If you want to publish scope package, You need to apply to create an organization on npmjs.com,at https://www.npmjs.com/org/create.
- Support for npm package provenance statements
jobs:
publish-npm:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write # Give permission to mint an ID-token
steps:
- uses: actions/checkout@v4
- run: npm ci
- run: npm run build
- uses: FrontEndDev-org/publish-node-package-action@v2
with:
target: npm
token: ${{ secrets.NPM_TOKEN }}
PreRequirements
- Requires GitHub Packages write access
- No need to publish token
Notes
- GitHub Packages
name
may change after release, in two cases:- For example, the original name
my-pkg
will be changed to@owner/my-kg
, whereowner
is the name of the owner name of the current repository - For example, the original name
@my-scope/my-pkg
will be changed to@owner/my-scope__my-kg
, whereowner
is the owner name of the current repository
- For example, the original name
- The name attribute in package.json in the repository will not be modified
jobs:
publish-github:
runs-on: ubuntu-latest
permissions:
packages: write
steps:
- uses: actions/checkout@v4
- run: npm ci
- run: npm run build
- uses: FrontEndDev-org/publish-node-package-action@v2
with:
target: github
token: ${{ github.token }}
Name | Required | Default | Description |
---|---|---|---|
target |
false | npm |
Packages target, optionally npm OR github |
token |
true | None | Target authorization token |
tag |
false | latest |
The version label to release, the default is latest |
dryRun |
false | false |
Pretend to publish, but don't actually upload to the registry. |
includePrivate |
false | false |
publish private packages as well. |
Nothing!