From 28d64c90d9f33ad03e16acc7c7fe66169ea674a5 Mon Sep 17 00:00:00 2001 From: hjenkins Date: Tue, 10 Dec 2019 17:11:33 +0000 Subject: [PATCH 1/4] Add notes on how to create a release --- README.md | 2 +- RELEASE.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 RELEASE.md diff --git a/README.md b/README.md index daae04cc..6ae5cff9 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..74aaca04 --- /dev/null +++ b/RELEASE.md @@ -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) From 61137f67a9b2360f2acad539ac3578ac440a03d7 Mon Sep 17 00:00:00 2001 From: Henry Jenkins Date: Tue, 10 Dec 2019 17:56:14 +0000 Subject: [PATCH 2/4] Update RELEASE.md --- RELEASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/RELEASE.md b/RELEASE.md index 74aaca04..f6516de9 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -43,4 +43,5 @@ Note this uses `v4.1.0` as an example release number. 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) From b8bfa226dd78766f24c576b57b8af08260906bbe Mon Sep 17 00:00:00 2001 From: Henry Jenkins Date: Mon, 16 Dec 2019 16:08:44 +0000 Subject: [PATCH 3/4] Update README.md Co-Authored-By: Joel Speed --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ae5cff9..e12532c0 100644 --- a/README.md +++ b/README.md @@ -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. For releasing see our guide to [release creation guide](RELEASE.md). +Please see our [Contributing](CONTRIBUTING.md) guidelines. For releasing see our [release creation guide](RELEASE.md). From 8602aa4f133864e9426fc9ed471d6be6aa4147f0 Mon Sep 17 00:00:00 2001 From: Henry Jenkins Date: Mon, 16 Dec 2019 16:13:51 +0000 Subject: [PATCH 4/4] Update RELEASE.md --- RELEASE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index f6516de9..1dc9b888 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -20,7 +20,7 @@ Note this uses `v4.1.0` as an example release number. 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) +5. Copy the release notes in to the draft Github release, adding a link to [CHANGELOG.md](CHANGELOG.md) 6. Update you local master branch ``` git checkout master @@ -29,19 +29,19 @@ Note this uses `v4.1.0` as an example release number. 7. Create & push the tag ``` git tag v4.1.0 - git push upstream --tags + git push --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 +9. Upload all the files (not the folders) from the `/release` folder to Github release as binary artefacts. There should be both the tarballs (`tar.gz`) and the checksum files (`sha256sum.txt`). 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` + Note: Ensure the docker tags don't include `-dirty`. This means you have uncommitted changes. 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)