Skip to content

aynp/node-automatic-release

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

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

Usage

Here is a sample workflow -

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/[email protected]
        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 guide or the default Publish Node.js Package workflow template by GitHub to automatically publish to NPM when version in package.json changes.

You can read more about it here - automatic-npm-publish