https://github.com/aynp/node-automatic-release
Automatically generate a new releases for your node project.
https://github.com/aynp/node-automatic-release
actions nodejs
Last synced: about 2 months ago
JSON representation
Automatically generate a new releases for your node project.
- Host: GitHub
- URL: https://github.com/aynp/node-automatic-release
- Owner: aynp
- License: apache-2.0
- Created: 2022-10-23T17:10:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-29T05:26:03.000Z (over 3 years ago)
- Last Synced: 2026-02-15T12:22:37.173Z (4 months ago)
- Topics: actions, nodejs
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/node-automatic-release
- Size: 181 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node Automatic Release
Automatically generate a new release for your node project when the version in your `package.json` changes.
**Marketplace Link - [node-automatic-release](https://github.com/marketplace/actions/node-automatic-release)**
## Usage
Here is a sample workflow -
```yaml
name: Automatic Release
on:
# When a change is pushed to package.json in main branch
push:
branches: ['main']
paths: ['package.json']
# Manual run
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
# Required to access package.json
- name: Checkout
uses: actions/checkout@v3
- name: Update Release
uses: aynp/node-automatic-release@v1.1.0
with:
draft_release: false
generate_release_notes: true
```
## Inputs
- `draft_release` - `true` to create a draft (unpublished) release, `false` to create a published one
- `generate_release_notes` - `true` to generate release notes from the commit messages, `false` otherwise.
## Publishing to NPM
This action can be used with [Publishing packages to the npm registry](https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages#publishing-packages-to-the-npm-registry) guide or the default [`Publish Node.js Package` workflow](https://github.com/actions/starter-workflows/blob/main/ci/npm-publish.yml) template by GitHub to automatically publish to NPM when version in `package.json` changes.
You can read more about it here - [automatic-npm-publish](https://aryanpathania.vercel.app/blog/automatic-npm-publish)