Release package to NPM #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Release package to NPM | |
| permissions: | |
| contents: write | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| release-type: | |
| description: "Release type (one of): patch, minor, major, prepatch, preminor, premajor, prerelease" | |
| required: true | |
| jobs: | |
| release: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Step 1: Checkout the code | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| # Step 2: Set up Node.js environment | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| registry-url: https://registry.npmjs.org/ | |
| node-version: "22" | |
| # Step 3: Install pnpm | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 9 | |
| # Step 4: Install dependencies | |
| - name: Install dependencies | |
| run: pnpm install | |
| # Step 5: Bump package version | |
| # Use tag latest | |
| - name: Bump release version | |
| if: startsWith(github.event.inputs.release-type, 'pre') != true | |
| run: | | |
| echo "NEW_VERSION=$(npm --no-git-tag-version version $RELEASE_TYPE)" >> $GITHUB_ENV | |
| echo "RELEASE_TAG=latest" >> $GITHUB_ENV | |
| env: | |
| RELEASE_TYPE: ${{ github.event.inputs.release-type }} | |
| # Step 5: Bump package pre-release version | |
| # Use tag beta for pre-release versions | |
| - name: Bump pre-release version | |
| if: startsWith(github.event.inputs.release-type, 'pre') | |
| run: | | |
| echo "NEW_VERSION=$(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 }} | |
| # Step 6: Update changelog unreleased section with new version | |
| - name: Update changelog | |
| uses: superfaceai/release-changelog-action@v2 | |
| with: | |
| path-to-changelog: CHANGELOG.md | |
| version: ${{ env.NEW_VERSION }} | |
| operation: release | |
| # Step 7: Commit changes | |
| - name: Commit CHANGELOG.md and package.json changes and create tag | |
| run: | | |
| git config user.name github-actions | |
| git config user.email [email protected] | |
| git add "package.json" | |
| git add "CHANGELOG.md" | |
| git commit -m "chore: release ${{ env.NEW_VERSION }}" | |
| git tag ${{ env.NEW_VERSION }} | |
| # Step 8: Publish version to public repository | |
| - name: Publish | |
| run: pnpm publish --verbose --access public --tag ${{ env.RELEASE_TAG }} | |
| env: | |
| NODE_AUTH_TOKEN: ${{ secrets.NPMJS_ACCESS_TOKEN }} | |
| # Step 9: Push repository changes | |
| - name: Push changes to repository | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| git push origin && git push --tags | |
| # Step 10: Read version changelog | |
| - id: get-changelog | |
| name: Get version changelog | |
| uses: superfaceai/release-changelog-action@v2 | |
| with: | |
| path-to-changelog: CHANGELOG.md | |
| version: ${{ env.NEW_VERSION }} | |
| operation: read | |
| # Step 11: Update GitHub release with changelog | |
| - name: Update GitHub release documentation | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| tag_name: ${{ env.NEW_VERSION }} | |
| body: ${{ steps.get-changelog.outputs.changelog }} | |
| prerelease: ${{ startsWith(github.event.inputs.release-type, 'pre') }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |