Skip to content

Commit

Permalink
README - update release process (#539)
Browse files Browse the repository at this point in the history
  • Loading branch information
rnetser authored May 17, 2022
1 parent f4743aa commit 70100e8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,6 @@ docs/source/rst

# General
local-cluster/_hco/

# nmp
node_modules/
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<your_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
Expand Down

0 comments on commit 70100e8

Please sign in to comment.