Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 2.89 KB

RELEASING.md

File metadata and controls

24 lines (21 loc) · 2.89 KB
Raw

Releasing a version:

  1. Create a fastlane/.env file with your GitHub API token (see fastlane/.env.SAMPLE). This will be used to create the PR, so you should use your own token so the PR gets assigned to you.
  2. Run bundle exec fastlane bump
    1. Confirm base branch is correct
    2. Input new version number
    3. Update CHANGELOG.latest.md to include the latest changes. Call out API changes (if any). You can use the existing CHANGELOG.md as a base for formatting. To compile the changelog, you can compare the changes between the base branch for the release (usually main) against the latest release, by checking https://github.com/revenuecat/purchases-hybrid-common/compare/<latest_release>...<base_branch>. For example, https://github.com/revenuecat/purchases-hybrid-common/compare/3.3.0...main.
    4. A new branch and PR will automatically be created
  3. Merge PR when approved
  4. Make a tag and push, the rest will be performed automatically by CircleCI. If the automation fails, you can revert to manually calling bundle exec fastlane deploy.

Hotfix Releases

Sometimes you might need to release a patch on a version that's not the latest. Or sometimes there might have been commits on main that shouldn't be released, but the latest version has a big bug. For example, let's say the last version is 4.0.0, but there's a bug on 3.9.0 that needs to be released as a 3.9.1:

  1. Open a PR with the fix, merge it to main.
  2. Jump to 3.9.0 and create a new branch release/3.9.0. Push this branch since it will be used as base for the PR you will open in the next steps.
  3. Run bundle exec fastlane bump as you would do with any release. This will create a new PR release/3.9.1. Make sure the base branch of the PR is pointing to release/3.9.0
  4. Locally, while in branch the release branch (release/3.9.1 in this case), cherry pick the changes with your fix that you just merged to main using git cherry-pick <sha_of_the_squashed_commit_in_main>. Fix any conflicts if there are any. Push the cherry picked commit to the remote branch release/3.9.1.
  5. When the PR is approved, approve the hold job in CircleCI as you would do for any other release. If there is no hold job because the release is older than when we introduced that job, manually tag the last commit in release/3.9.1 with 3.9.1.
  6. CircleCI will start the deployment process
  7. Merge the PR after the release has been completed and delete both release/3.9.0 and release/3.9.1 branches.
  8. Do npm dist-tag add @revenuecat/[email protected] latest and npm dist-tag add @revenuecat/[email protected] latest. Being x.x.x the latest version of purchases-typescript-internal. When doing the publish to npm, the latest version is overriden with the hotfix, so we need to set it back to the latest version.
  9. Remember to edit the CHANGELOG.md in main to include the version that has been just released