From ccaa8b6cb54ac92b4a57ea1f64ca1821dd4f679d Mon Sep 17 00:00:00 2001 From: rnetser Date: Tue, 17 May 2022 10:14:43 +0300 Subject: [PATCH] README - update release process --- .gitignore | 3 +++ README.md | 17 ++++++++++------- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index e9ef8640fb..960e210919 100644 --- a/.gitignore +++ b/.gitignore @@ -118,3 +118,6 @@ docs/source/rst # General local-cluster/_hco/ + +# nmp +node_modules/ diff --git a/README.md b/README.md index 332444ef01..520278a825 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,22 @@ pip install openshift-python-wrapper --user ## Release new version ### requirements: -* gh [github cli](https://github.com/cli/cli/releases/) +* Export GitHub token ```bash -gh auth login # Follow login instructions +export GITHUB_TOKEN= ``` -* [npm](https://docs.npmjs.com/about-npm) +* [release-it](https://github.com/release-it/release-it) ```bash -sudo npm install github-release-notes -g +sudo npm install --global release-it +npm install --save-dev @j-ulrich/release-it-regex-bumper +rm -f package.json package-lock.json ``` -* export GREN_GITHUB_TOKEN=< TOKEN > -* Run ./scripts/release.sh providing source branch and target version (must be executed from main branch) ### usage: +* Create a release, run from the relevant branch. +To create a 4.10 release, run: ```bash -./scripts/release.sh main v1.5.5 +git checkout v4.10 +release-it # Follow the instructions ``` ## docs