Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.64 KB

RELEASE_GUIDELINES.md

File metadata and controls

70 lines (50 loc) · 2.64 KB
Raw

Release Guidelines

The release manager in charge can release an Openminers version using two scripts:

The release manager will need the right permissions for:

  • github.com

If you are new in this role, ask for the proper setup you need to run this process manually.

Process of release

  1. Create a branch called release/VERSION, having VERSION with the version to release.

  2. Within the release branch:

  3. Update the version executing:./scripts/release/versioning.sh --update UPDATE_TYPE 1. UPDATE_TYPE could be major, minor or patch.

  4. Add release notes to CHANGELOG executing: ./scripts/release/add_notes_changelog.sh -A -V NEW_VERSION -P PREVIOUS_TAG -T GH_ACCESS_TOKEN 1. NEW_VERSION: e.g.: 3.6.4 1. PREVIOUS_TAG: e.g.: v3.6.3 1. GH_ACCESS_TOKEN: A github personal access token you need.

  5. Test the release branch and verify that it meets the requirements.

  6. After merging the release branch; Run the release script

Versioning script usage

Options:

  • -U, --update: type of update. It could be major, minor, patch or rc (release candidate).
  • -A, --apply: This specify to apply the release. Without this the versioning will just show a dry run with no changes.

Release script usage

Options:

  • -A, --apply: This specify to apply the release. Without this the release will just show a dry run with no changes.
  • -T,--github-token: A github personal access token to interact with the Github API.

Github token

Since you need to use a secret when releasing openminers (github personal access token), I encourage you to use pass or a similar tool that allows you to store the secret safely and not expose it in the history of the machine you use.

So you can have:

GITHUB_ACCESS_TOKEN=$(pass github/your_personal_token_with_permisions)

or

GITHUB_ACCESS_TOKEN=$(whatever you need to get the token safely)

Executions

So, executing the script to release a minor version will be:

# For a dry run
./scripts/release/release.sh

# Applying changes
./scripts/release/release.sh --apply --github-token $GITHUB_ACCESS_TOKEN`

Checking release

After the execution of the release script we would have generated: