Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Latest commit

 

History

History
39 lines (27 loc) · 2.1 KB

release-guide.md

File metadata and controls

39 lines (27 loc) · 2.1 KB
Raw

How to Release

Prerequisites

GraphQL Metadata follows semantic versioning. Please ensure the release version you create follows this.

Stable release

  1. Create a new branch from master: git checkout -b chore/release-x.x.x (x.x.x represents the new version).
  2. Change the package.json version to the new version.
  3. Create a commit: chore(release): release version x.x.x.
  4. Push your branch and create a pull request to master.
  5. Once merged, you can publish the release through Git tagging or GitHub.

Pre-release

If your a creating a pre-release, you do not need to update the package.json. To trigger a pre-release, append the version with -xxx; for example: 1.0.0-beta1. You can do this by following the Git tagging or GitHub steps below.

Git tagging

  1. git tag x.x.x (x.x.x being the new version).
  2. git push origin x.x.x.
  3. Go to the release tag in GitHub and click Edit tag.
  4. Update the Release title to x.x.x.
  5. If it is a pre-release, tick the This is a pre-release checkbox.
  6. In the description, add the release notes from the CHANGELOG.
  7. The release workflow will be triggered. You can monitor progress in the GitHub Actions view.

See Git tagging for a complete guide on this process.

Releasing through GitHub

  1. Create a new release through the releases view.
  2. Set the Tag version to your release version: x.x.x.
  3. Set the Release title to your release version: x.x.x.
  4. If it is a pre-release, tick the This is a pre-release checkbox.
  5. In the description, add the release notes from the CHANGELOG.

See creating releases through GitHub for the official guide on this process.