Skip to content

Publish Package to npmjs #1

Publish Package to npmjs

Publish Package to npmjs #1

Workflow file for this run

# For details see: https://superface.ai/blog/npm-publish-gh-actions-changelog
name: Release package
on:
workflow_dispatch:
inputs:
release-type:
type: choice
required: true
description: 'The release type that will be passed to npm version command'
options: ['patch', 'minor', 'major', 'prepatch', 'preminor', 'premajor', 'prerelease']
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Ensure running on main branch
if: github.ref_name != github.event.repository.default_branch
run: |
echo "This workflow must not be triggered on a branch other than main"
exit 1
# Checkout project repository
- name: Checkout
uses: actions/checkout@v4
with:
# Using deploy key to push changes to repository
# See: https://stackoverflow.com/a/76135647
ssh-key: ${{ secrets.DEPLOY_KEY }}
# Configure Git
- name: Configure Git
run: |
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --global user.name "GitHub Actions"
# Setup Node.js environment
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
registry-url: https://registry.npmjs.org/
# Bump package version
# Use tag 'latest'
- name: Bump release version
if: startsWith(github.event.inputs.release-type, 'pre') != true
run: |
echo "TAG_NAME=$(npm --no-git-tag-version version $RELEASE_TYPE)" >> $GITHUB_ENV
echo "RELEASE_TAG=latest" >> $GITHUB_ENV
env:
RELEASE_TYPE: ${{ github.event.inputs.release-type }}
# Bump package pre-release version
# Use tag 'beta'
- name: Bump pre-release version
if: startsWith(github.event.inputs.release-type, 'pre')
run: |
echo "TAG_NAME=$(npm --no-git-tag-version --preid=beta version $RELEASE_TYPE)" >> $GITHUB_ENV
echo "RELEASE_TAG=beta" >> $GITHUB_ENV
env:
RELEASE_TYPE: ${{ github.event.inputs.release-type }}
- name: Build and bump package version in examples
run: |
npm ci && cd examples
cd room-manager && npm i @fishjam-cloud/js-server-sdk && cd ..
# Commit changes
- name: Commit changed files and create a new tag
run: |
git add package.json package-lock.json examples/room-manager/package-lock.json
git commit -m "Release ${{ env.TAG_NAME }}"
git tag ${{ env.TAG_NAME }}
# Publish version to public repository
- name: Publish
run: npm publish --verbose --access public --tag ${{ env.RELEASE_TAG }}
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
# Push repository changes
- name: Push changes to repository
run: |
git push origin && git push --tags
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Create GitHub release with autogenerated notes
- name: Create GitHub release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ env.TAG_NAME }}
prerelease: ${{ startsWith(github.event.inputs.release-type, 'pre') }}
generate_release_notes: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}