From c63f436e81d2e3e0199ad2c3b9e641973ba33b6b Mon Sep 17 00:00:00 2001 From: Jordan Dubrick Date: Tue, 10 Dec 2024 14:34:04 -0500 Subject: [PATCH] consolidate into one readme Signed-off-by: Jordan Dubrick --- release/PROCESS.md | 42 +++++++++++++++++++++++++++++----- release/README.md | 56 ---------------------------------------------- 2 files changed, 36 insertions(+), 62 deletions(-) delete mode 100644 release/README.md diff --git a/release/PROCESS.md b/release/PROCESS.md index 94c93485..d517b02b 100644 --- a/release/PROCESS.md +++ b/release/PROCESS.md @@ -42,17 +42,47 @@ Changes within PRs can be highlighted as well with the PR as a base change. ## Cutting Releases -Individuals performing releases can find more information related to the process below. +Individuals performing releases can find more information related to the process below. After the use of the release script you will have all the required branches and GitHub tags created for you. The final steps will be to create the [release on GitHub](https://github.com/devfile/registry-support/releases/new), and send out a release notification to users. + +### Requirements + +- SSH key setup with GitHub + - See [GitHub documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) for more information +- Write access to the [devfile/registry-support](https://github.com/devfile/registry-support) repository + ### Major Releases -- See the dedicated release documentation [here](./README.md). +Example major release: +``` +export VERISON=1.1.1 +export RELEASE_TYPE=major +bash release.sh +``` + +Example major release as a pre-release: +``` +export VERSION=2.0.0 +export RELEASE_CANDIDATE=true +export RELEASE_TYPE=major +bash release.sh +``` ### Minor Releases -- See the dedicated release documentation [here](./README.md). - +Example minor release: +``` +export VERSION=2.1.0 +export RELEASE_TYPE=minor +bash release.sh +``` ### Patch Releases -- See the dedicated release documentation [here](./README.md). -- If necessary, backport the change to the previous 2 releases. \ No newline at end of file +Example patch release: +``` +export VERSION=2.1.1 +export RELEASE_TYPE=patch +bash release.sh +``` + +If necessary, backport the changes to the previous 2 releases. \ No newline at end of file diff --git a/release/README.md b/release/README.md deleted file mode 100644 index 02720072..00000000 --- a/release/README.md +++ /dev/null @@ -1,56 +0,0 @@ -# Cutting New Releases - -## Requirements - -- SSH key setup with GitHub - - See [GitHub documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) for more information -- Write access to the [devfile/registry-support](https://github.com/devfile/registry-support) repository - -## Process - -Information related to the release process can be found [here](https://docs.google.com/document/d/1JYnQf0M2VcZhJuHn6dxPEYNZ7icoViqJe8dN1jnKsCw/edit?usp=sharing). - -In order to use the script you will need to consider and set the following: - -1. Determine version and type you wish to cut - 1. E.g. "I want to cut version 2.0.0, which is a Major release" - 2. Or "I want to cut version 2.1.0, which is a Minor release" -2. Set the appropriate environment variables - 1. `VERSION` - - In the form [Major].[Minor].[Patch] - 2. `RELEASE_TYPE` - - One of [major, minor, patch] - 3. `RELEASE_CANDIDATE` - - Defaults to `false` if unset - - Only applicable for `major` release types - -## Examples - -Major release v1.1.1 -``` -export VERISON=1.1.1 -export RELEASE_TYPE=major -bash release.sh -``` - -Major release v2.0.0 that is a release candidate -``` -export VERSION=2.0.0 -export RELEASE_CANDIDATE=true -export RELEASE_TYPE=major -bash release.sh -``` - -Minor release v2.1.0 -``` -export VERSION=2.1.0 -export RELEASE_TYPE=minor -bash release.sh -``` - -Patch release v2.1.1 -``` -export VERSION=2.1.1 -export RELEASE_TYPE=patch -bash release.sh -``` \ No newline at end of file