Skip to content

README - update release process #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2022
Merged

README - update release process #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
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
View file
Open in desktop
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