Skip to main content

Create A Release

We will be migrating to using/creating Releases to move code from development to Production.

Repos using Release Workflow

For now, only the following repos have been fully migrated to using Release Workflow in creating production releases.

  1. BookADoc Marketing

This page will be updated as more repos are migrated.

Some of the benefits of using Releases are

  1. GitHub best practices
  2. Easy to identify all the branches, changes, improvements, bug fixes and (new) features contained in the release
  3. When linked with Jira, makes it easy to identify all the Jira issues/tickets that are in the current release
  4. Gives the ability to use Semantic Versioning (Semver) when doing releases.
tip

In the unlikely event that a change/branch/PR which has been merged into main is not to be released, then you will need to revert the un-needed change/branch/PR by creating a revert PR.

Steps to creating/drafting a New Release​

  1. Ensure that all builds have passed, PRs have been approved and merged in. Only code or PRs that need to be released should have been merged in.

  2. On GitHub,

    (i) in the middle right section, click on Releases

    Releases

    OR

    (ii) in the top area, click on Tags

    Tags

  3. Ensure that the Releases tab is selected

    Releases Tab

    View Release History

    On this page you can see a list of past releases, the PR's and a full changelog of all the code changes that were released.

  4. Click on Draft a new release button

    Draft New Release Button

  5. Click the Choose a tag dropdown button

    Choose a tag

  6. Enter the next tag value. Eg. If the last released tag was v1.0.4 enter v1.0.5 and then click on the Create new tag: v1.0.5 on publish button

    Create New Tag

  7. Click the Target dropdown and ensure main is selected.

    Target branch

    note

    It is possible to select another branch here, eg prod when creating the release.

  8. Click on Generate release notes button

    Generate release notes

    Review the details in the description box below. In most cases, you will not need to edit it

  9. Once everything looks good, click on the Publish release button to public the selected or target branch to production.

    Publish release