Skip to content

Latest commit

 

History

History
112 lines (83 loc) · 6.08 KB

README.md

File metadata and controls

112 lines (83 loc) · 6.08 KB
Raw

🚀 PR Voyager

PR Voyager is an automated workflow powered by GitHub Actions that streamlines the process of npm package publishing for each Pull Request (PR). It ensures that every code change in your PR is accompanied by a new npm package version, facilitating smooth integration and testing of your updates.

PR Voyager's comment

Features

  • Seamlessly integrates with your PR workflow on GitHub.
  • Automatically publishes npm packages with version updates tied to your PR.
  • Ensures that every code change is released as part of the PR process.
  • Simplifies local testing by providing clear instructions for installing and using the updated packages.
  • Enhances collaboration by enabling team members to easily test and review PR changes using the latest package versions.

Package Versioning

For each PR, the package version in your package.json is automatically updated in the following format: 1.0.0-pr123.366b952, where:

  • 1.0.0 represents the current version.
  • 123 is the PR number.
  • 366b952 is the first 7 characters of the commit SHA.

The package is also published with a tag named pr123, where 123 is the PR number.

This versioning and tagging scheme ensures that each PR receives a unique package version and allows for easy identification and testing of changes.

Usage

Inputs

Name Description Required Default
publish The command to use to build and publish packages true
cwd Sets the cwd for the node process. false process.cwd()

Example workflow

name: PR Release

on:
  pull_request:

jobs:
  pr-release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      # Uncomment this if you're using pnpm
      # - name: Install pnpm
      #   uses: pnpm/action-setup@v2
      #   with:
      #     version: 8

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 16
          cache: npm # or pnpm

      - name: Install Dependencies
        run: npm ci # or pnpm install

      - name: Build
        run: npm build # or pnpm build

      - name: Publish
        uses: kotarella1110/pr-voyager@v0
        with:
          publish: npm publish # or pnpm publish -r
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

By default, the GitHub Action creates an .npmrc file to authenticate with the npm registry when publishing packages.

However, if you already have an .npmrc file in your repository, the GitHub Action recognizes it and doesn't recreate the file. This is useful if you need to customize your .npmrc file for any specific configurations.

For instance, if you want to manually create the .npmrc file before running the GitHub Action, you can add a step like this:

+ - name: Create .npmrc
+   run: |
+     echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" >> $HOME/.npmrc
+   env:
+     NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
  - name: Publish
    uses: kotarella1110/pr-voyager
    with:
      publish: npm publish
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-     NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

PR Voyager vs CodeSandbox CI

PR Voyager and CodeSandbox CI offer distinct approaches for automating and managing your package testing and publishing workflows. Here's a summary of their key differences:

PR Voyager CodeSandbox CI
Platform GitHub Action GitHub App
Support Repositories Public and private repositories Public repositories only
Configuration Created via a .github/workflows/xxx.yml workflow file. Flexible and customizable workflows Configured via a .codesandbox/ci.json configuration file, enabling easy setup. However, it has limited flexibility and lacks the ability to specify package manager versions.
Publishing Publishes to npm with tagged name Publishes to CodeSandbox CI registry. Does not publish to npm .
Integration Allows immediate local testing of the library. Integrates with CodeSandbox for immediate library testing, both locally and on CodeSandbox.

Ultimately, both tools offer valuable contributions to your development workflow, allowing you to choose the one that best aligns with your priorities and preferences. Whether you prioritize flexibility and customization or seamless integration and simplicity, these solutions can enhance your package management process and contribute to more efficient and effective development.