go/oauth2-proxy
1
0
Fork 0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2025-01-08 04:03:58 +02:00
Code Issues Releases Activity

Add notes on how to create a release

Browse Source
This commit is contained in:
hjenkins 2019-12-10 17:11:33 +00:00
parent 8165f6c483
commit 28d64c90d9
2 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -47,4 +47,4 @@ If you would like to reach out to the maintainers, come talk to us in the `#oaut
## Contributing
Please see our [Contributing](CONTRIBUTING.md) guidelines.
Please see our [Contributing](CONTRIBUTING.md) guidelines. For releasing see our guide to [release creation guide](RELEASE.md).

46
RELEASE.md Normal file
View File

@ -0,0 +1,46 @@
# Release
Here's how OAuth2_Proxy releases are created.
## Schedule
Our aim is to release once a quarter, but bug fixes will be prioritised and might be released earlier.
## The Process
Note this uses `v4.1.0` as an example release number.
1. Create a draft Github release
* Use format `v4.1.0` for both the tag and title
2. Update [CHANGELOG.md](CHANGELOG.md)
* Write the release highlights
* Copy in headings ready for the next release
3. Create release commit
```
git checkout -b release-v4.1.0
```
4. Create pull request getting other maintainers to review
5. Copy the release notes in to the draft Github release, adding a link to the [changelog](CHANGELOG.md)
6. Update you local master branch
```
git checkout master
git pull
```
7. Create & push the tag
```
git tag v4.1.0
git push upstream --tags
```
8. Make the release artefacts
```
make release
```
9. Upload all the files (not the folders) from the `/release` folder to Github release as binary artefacts
10. Publish release in Github
11. Make and push docker images to Quay
```
make docker-all
make docker-push-all
```
Note: Ensure the docker tags are tags aren't `-dirty`
12. Verify everything looks good at [quay](https://quay.io/repository/pusher/oauth2_proxy?tag=latest&tab=tags) and [github](https://github.com/pusher/oauth2_proxy/releases)