Creating Releases - digitalgroundgame/pragmatic-papers GitHub Wiki

← Table of Contents

Overview

Our branch protection rules require a Pull Request (PR) to be reviewed and approved before merging. When dev is ready to release, we open a PR directly from dev into main.

The flow is:

release/v1.0.0        →  PR → dev
dev                   →  PR → main

Step by Step

  1. Create a new branch from dev
git checkout dev
git pull origin dev
git checkout -b release/v1.0.0
  1. Make your changes

Update the package.json version number. This version should match the tag in step 7.

git add .
git commit -m "Release v1.0.0"
git push origin release/v1.0.0
  1. Create a pull request from your branch to dev
gh pr create -f -B dev

  1. Get it reviewed and approved, then merge into dev.

  2. Create a pull request from dev to main

git checkout dev
git pull origin dev
gh pr create -f -B main

  1. Get it reviewed and approved, then Merge (Regular Merge) into main.

  2. Tag the release

You will need a GPG Key registered with your GitHub User Account to sign the tag with -s. Signed tags get a verified badge on GitHub.com.

git checkout main
git pull origin main
git tag v1.0.0 -m "v1.0.0" -s
git push origin v1.0.0

[!NOTE] We use semantic versioning for our tags.

  1. Create the release
gh release create v1.0.0 --target main -t "v1.0.0"

Further Reading