songtradr / semantic-release-npm

Semantically (pre-)release package to npm

songtradr/semantic-release-npm action

Semantically (pre-)release package

Automatically publish new versions and preview versions of pull requests to npm using semantic-release and semantish-prerelease.

Use

### .github/workflows/release.yml
name: Release

on:
  push:
    branches:
      - main
      - next
      - next-major
      - beta
      - alpha
      - "*.x"
  pull_request:

permissions:
  actions: write
  contents: write
  issues: write
  pull-requests: write
  packages: write

defaults:
  run:
    shell: bash

jobs:
  release:
    runs-on: ubuntu-latest
    name: Build & Publish
    steps:
      - name: 🛑 Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.9.1

      - name: ⬇️ Checkout repo
        uses: actions/checkout@v3

      - name: ⎔ Setup node
        uses: actions/setup-node@v3
        with:
          node-version: 16
          ### Optionally configure your private npm here
          registry-url: "https://npm.pkg.github.com"
          scope: "@songtradr"

      ### test, build, prepare here

      ############################################################
      # All above is opinionated, all below is about this action #
      ############################################################

      - name: 🚀 Publish
        uses: songtradr/semantic-release-npm@v1
        ### All options are optional
        with:
          ### npm token to authenticate against the registry (Default: ${{ github.token }})
          npm_token: ${{ github.token }}
          ### GitHub PAT to create the release with (Default: ${{ github.token }})
          gh_token: ${{ github.token }}
          ### The directory in which the release should be performed (Default: .)
          directory: .
          ### Custom branches configuration (see https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches)
          ### (Default: false) - false uses configuration from release.config.js
          branches: main, next
          ### Wether to publish preview releases for pull requests (Default: true)
          pre_release: true
          ### Wether to apply common configuration for semantic release (Default: true)
          add_config: true