Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.58 KB

README.md

File metadata and controls

60 lines (38 loc) · 2.58 KB
Raw

Release

This repository uses 🦋 Changesets to manage releases.

Creating a release

To create a release, follow these steps:

  1. Make changes to the codebase.
  2. Run tests and ensure everything is working as expected.
  3. Commit all your changes to the feature branch.
  4. From the root of the project, execute the following command.
# Root of the project
pnpm changeset

Note: Changeset identifies the changed packages comparing your feature branch with the master branch. If these branches are not properly synced with remote, you'll some irrelevant packages listed under changed packages. It is recommended to rebase your feature branch and master branch with remote before executing pnpm changeset.

This will open a prompt to select the packages that have changed. Select the packages that have changed and press Enter.

changesets-001

Then, it will open a prompt to select the type of change. Select the type of change and press Enter.

changesets-002

Lastly, it will open a prompt to enter a summary of the changes. Enter a summary and press Enter. (Additionally, if you want to have an editor view to enter a long summary with line breaks, press Enter without typing anything.)

Note Please enter a meaningful summary of the changes. This will be used in the changelog.

Regular Summary Prompt

changesets-summary-001

  1. Then commit the generated changeset file with the following commit message.
Add changeset 🦋
  1. Push your changes and changeset commit to the remote repository.
  2. Create a pull request for your changes and assign a reviewer.
  3. After the pull request is reviewed and approved, merge it into the master branch.

Merging the autogenerated version bump PR.

  1. After you've merged your PR, Changesets will version the packages that have changed and create a PR with the version bump. You can find the PR in the pull requests tab.

💡 Sample PR title: [Release] [GitHub Action] Update package versions.

  1. Approve and merge the PR.

    Warning Do not squash and merge.

changesets-autogen-pr-1

Note A release build will run automatically after the version bump PR is merged. The changed apps and package artifacts will be released to GitHub and Nexus.