Skip to main content

Prerelease Process for Component library

This guide outlines the step-by-step process for creating a prerelease of the @adjust/components package using GitHub Actions. Prereleases enable you to test the package in your application before making an official release.

Prerelease Workflow​

To create a prerelease of the @adjust/components package, you need to trigger the workflow in GitHub Actions manually.

Steps to Trigger a Prerelease​

  1. Navigate to GitHub Action

  2. Run the Workflow

    • Click the "Run workflow" button.
    • In the dropdown menu, select the branch from which you want to create the prerelease.
    • Click "Run workflow" to initiate the process.

Run Workflow

  1. Prerelease version is published
    • Once the workflow completes successfully, a prerelease version of the @adjust/components package will be published to the package registry and will be available for use.
    • You can also find the published prerelease version in the workflow output.

Prerelease version

Additional Notes​

  • Ensure that your branch has the latest changes before triggering the workflow.
  • If the workflow is triggered multiple times, the alpha version will increment automatically.
    • If the version in package.json is 18.2.0, 18.2.0-alpha.1 will be published.
    • On the second run, the version will increment to 18.2.0-alpha.2, and so on.
  • The prerelease package will be published to the package registry, making it available for testing.
  • For troubleshooting, check the workflow logs in GitHub Actions.