nearform-actions/Auto Publish
Automatically publish to NPM and create Github release
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | Your Github token, it's already available to your Github action | no | ${{ github.token }} |
| npm-token | Your Npm Publish token, if you do not wish to publish to Npm, skip this | no | — |
| build-command | The bash command to execute after the version bump and before opening the PR | no | — |
| optic-url | URL if you have a custom application that serves OTP | no | https://optic-zf3votdk5a-ew.a.run.app/api/generate/ |
| optic-token | Your Optic token. You can add your Npm secret to the Optic app, generate a new token and pass it to this input. Required only if you want to pubish to Npm and have MFA enabled for your account | no | — |
| actor-name | The name you want to see in the new release commit. | no | ${{ github.actor }} |
| actor-email | The email you want to see in the new release commit | no | actions@users.noreply.github.com |
| semver | The semver to use for this new release | yes | patch |
| npm-tag | If you want to release to the Npm with a custom tag, pass it here | no | latest |
| api-url | Url of the API where the application is running | no | https://optic-release-automation.nearform.com/ |
| app-name | Name of the github app that authors optic PRs in the following format: `app-name[bot]` | no | optic-release-automation[bot] |
| sync-semver-tags | If you want to keep the major and minor versions tag synced to the latest appropriate commit | no | false |
| commit-message | The commit message template. The keyword "{version}" will be replaced with the new version | no | Release {version} |
| revert-commit-after-failure | If the release fails while publishing to NPM and to GitHub, setting this flag to "true", will revert the release commit. When using this flag, make sure the action is able to push directly to the main branch | no | false |
| notify-linked-issues | If the flag is set to "true", a comment will be posted on each issue that is linked to the pull requests included in each release. The default setting is "true". | no | true |
| artifact-path | Set this input to the distribution folder or file you want to add as the main asset for your release. It will be downloadable from the release page and a preview of it will be available in the pull request. | no | — |
| version-prefix | A prefix to apply to the version number, which reflects in the tag and GitHub release names | yes | v |
| prerelease-prefix | A prefix to apply to the prerelease version number | no | — |
| base-tag | This input allows you to specify a base release and will include all changes made in releases between the base release and the latest release | no | — |
| provenance | If true, NPM >9.5 will attempt to generate and display a "provenance" badge. See https://docs.npmjs.com/generating-provenance-statements | no | false |
| access | If defined, sets package to public or restricted via `--access` flag on `npm publish`. Supported values are "restricted" or "public". | no | — |
| publish-mode | Choose how to publish to npm: "token" (default), "oidc" (Trusted Publishing), or "none" (skip npm publish) | no | token |
| ngrok-token | Your Ngrok Auth Token. Required only if you want to pubish to Npm and have MFA enabled for your account | no | — |
| bump-command | The command to use to bump the version of the pacakge. It defaults to npm version | no | — |
| get-version-command | The command to use to get the current version of the package. It defaults to npm get pkg version | no | — |
Outputs
no outputs