Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Commit

Permalink
Update operations docs release section
Browse files Browse the repository at this point in the history
  • Loading branch information
JakubFrejlach committed Nov 22, 2023
1 parent 180a977 commit d5698b2
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions docs/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,46 @@

github actions

define secrets
define secrets

## Release

Follow this procedure when performing Griffon version X.Y.Z release.

1) Checkout main branch
1) Clone/update master branch

```
$ git checkout main
$ git fetch --all
$ git rebase origin/main
```
2) Create release branch
2) Start release script and follow instructions
* create a new release branch
```
$ git checkout -b vX.Y.Z
```
* bump version in griffon/__init__.py __version__ variable
* ensure CHANGELOG.md is updated accordingly
* commit / push changes to release branch
* raise PR
```
$ make release type=<major|minor|patch>
```
NOTE: if `type` is not specified, patch release will be performed
This will:
* create a new branch
* replace version on all places with new Griffon version based on the latest Griffon version and release type
* commit and push the changes
* open pull request creation in browser
3) Confirm PR creation opened by the relase script
4) Confirm checks passes
3) Review and merge PR
5) Merge PR
4) Create a new release and tag via [GitHub WebUI](https://github.com/RedHatProductSecurity/griffon/releases/new) - this will also trigger the build and upload to PyPI
6) Create a new release and tag via [GitHub WebUI](https://github.com/RedHatProductSecurity/griffon/releases/new) - this will also trigger the build and upload to PyPI
* Tag and release needs be in format x.x.x to comply with [semantic versioning](#version-policy)
* Tag needs to point to the latest commit
* Release description should include the newest section of the [CHANGELOG.md](CHANGELOG.md)
## Versioning
Griffon uses [Semantic Versioning](https://semver.org/).
Griffon uses [Semantic Versioning](https://semver.org/).
Griffon starts official versioning at v0.1.0.

0 comments on commit d5698b2

Please sign in to comment.