Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iuccio/npm-semver-publish-action
GitHub action to publish npm packages with semantic versioning rules
https://github.com/iuccio/npm-semver-publish-action
npm publishing release semver semver-release semver-release-github-action semver-release-tag semver-release-tag-github-action tagging
Last synced: about 4 hours ago
JSON representation
GitHub action to publish npm packages with semantic versioning rules
- Host: GitHub
- URL: https://github.com/iuccio/npm-semver-publish-action
- Owner: iuccio
- License: gpl-3.0
- Created: 2024-03-01T16:26:10.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T15:55:12.000Z (7 months ago)
- Last Synced: 2024-08-09T16:16:06.281Z (5 months ago)
- Topics: npm, publishing, release, semver, semver-release, semver-release-github-action, semver-release-tag, semver-release-tag-github-action, tagging
- Language: JavaScript
- Homepage: https://iuccio.github.io/npm-semver-publish-action/
- Size: 300 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# GitHub action to publish npm packages with semanantic versioning rules
[](https://github.com/iuccio/npm-semantic-publish-action/actions/workflows/ci.yml)
[](https://github.com/iuccio/npm-semantic-publish-action/actions/workflows/codeql-analysis.yml)
[](https://github.com/iuccio/npm-semantic-publish-action/actions/workflows/linter.yml)
[](https://github.com/iuccio/npm-semantic-publish-action/actions/workflows/check-dist.yml)
[](https://npmjs.org/package/npm-semantic-publish)
[](https://npmjs.org/package/npm-semantic-publish)
[](badges/coverage.svg)
[](https://github.com/marketplace/actions/npm-semver-publish)
Follow [me](https://github.com/iuccio), and consider starring the project to
show your :heart: and support.
## Table of Contents
- [GitHub action to publish npm packages with semanantic versioning rules](#github-action-to-publish-npm-packages-with-semanantic-versioning-rules)
- [Table of Contents](#table-of-contents)
- [Semantic versioning over commit message](#semantic-versioning-over-commit-message)
- [Action usage](#action-usage)
- [Action Parameters](#action-parameters)
- [Complete action example](#complete-action-example)
- [Action configuration Step-by-Step](#action-configuration-step-by-step)
- [Step1 - Secrets Configuration](#step1---secrets-configuration)
- [Step 2](#step-2)
- [Step 3](#step-3)
- [Step 4](#step-4)
- [Step 5](#step-5)
- [Development](#development)
- [License](#license)
- [Buy me a Coffee](#buy-me-a-coffee)
This action allow your project to create a new release, based on
[semantic versionig](https://semver.org/) principles, and publish it to your npm
registry.
## Semantic versioning over commit message
To generate a new version (git tag and npm package publishing), you have just to
add to the commit message one of the following key:
- **[MAJOR]** or **[major]**: new major release, e.g. v1.0.0 -> v2.0.0 will be
executed
- `git commit -m "add best feature ever [major]"`
- **[PATCH]** or **[patch]**: new patch release, e.g. v1.0.0 -> v1.0.1 will be
executed
- `git commit -m "fix best feature ever [patch]"`
- without any of the above keywords a new minor release will be executed, e.g.
v1.0.0 -> v1.1.0
- `git commit -m "update best feature ever"`
An new release is only exeuted on the defined **target-branch** (see **Action
Usage**)
## Action usage
### Action Parameters
See [action.yml](action.yml)
| Name | Type | Default | Description |
| :-----------: | :----: | :-----: | :----------------------------------------: |
| target-branch | string | master | Branch name new release should be executed |
| provenance | string | false | NPM package provenance |
:heavy_exclamation_mark: When the Action Parameter **provenance** is set to true
the **id-token** permission must be set to **write**:
```yaml
permissions:
id-token: write
```
### Complete action example
```yaml
on:
push:
branches: master #the branch name must be the same of **target-branch**
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: write #allow to push on git repo
id-token: write #allow to publish npm package
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4 #checkout git repo
uses: actions/setup-node@v4 #setup node env
with:
node-version: 20.x
registry-url: 'https://registry.npmjs.org'
- name: Run my Action
id: run-action
uses: iuccio/[email protected] #execute npm semver publish
with:
target-branch: master
provenance: true
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} #npm token
```
## Action configuration Step-by-Step
### Step1 - Secrets Configuration
This action requires the **NPM_TOKEN** secret configuretion:
1. generate a new npm token able to publish
[Creating and viewing access tokens](https://docs.npmjs.com/creating-and-viewing-access-tokens)
1. add the above generated token in the secret **NPM_TOKEN** (see
[Using secrets in GitHub Actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions))
### Step 2
Add permissions to to push on git and publish on npm
```yaml
permissions:
contents: write
id-token: write
```
### Step 3
Add to the checkout action:
```yaml
uses: actions/checkout@v4
```
### Step 4
Add an [actions/setup-node](https://github.com/actions/setup-node) step to your
workflow. If you have one already, ensure that the registry-url input is set
(e.g. to [https://registry.npmjs.org](https://registry.npmjs.org)) so that this
action can populate your .npmrc with authentication info:
```yaml
uses: actions/setup-node@v4
with:
node-version: 20.x
registry-url: 'https://registry.npmjs.org'
```
### Step 5
add **actions/npm-semver-publish** step:
```yaml
name: Run my Action
id: run-action
uses: iuccio/[email protected]
with:
target-branch: 'master' #where a new release is applied
provenance: true #if you want to publish on npm registry the provenance
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
```
That's it!
## Development
See [Development](DEVELOPMENT.md) for more information.
## License
CSVtoJSON is licensed under the GNU General Public License v3.0
[License](LICENSE).
## Buy me a Coffee
Just if you want to support this repository:
- **BTC** tip address: 37vdjQhbaR7k7XzhMKWzMcnqUxfw1njBNk