diff --git a/CHANGELOG.md b/CHANGELOG.md index 65803040..7531f506 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,28 @@ # Vx.x.x (Pre-release) +## Important Notes + +## Breaking Changes + +## Changes since v4.1.0 +- [#325](https://github.com/pusher/oauth2_proxy/pull/325) dist.sh: use sha256sum (@syscll) + +# v4.1.0 + +## Release Highlights +- Added Keycloak provider +- Build on Go 1.13 +- Upgrade Docker image to use Debian Buster +- Added support for FreeBSD builds +- Added new logo +- Added support for GitHub teams + +## Important Notes +N/A + +## Breaking Changes +N/A + ## Changes since v4.0.0 - [#292](https://github.com/pusher/oauth2_proxy/pull/292) Added bash >= 4.0 dependency to configure script (@jmfrank63) - [#227](https://github.com/pusher/oauth2_proxy/pull/227) Add Keycloak provider (@Ofinka) @@ -18,6 +41,7 @@ - [#248](https://github.com/pusher/oauth2_proxy/pull/248) Fix issue with X-Auth-Request-Redirect header being ignored (@webnard) - [#314](https://github.com/pusher/oauth2_proxy/pull/314) Add redirect capability to sign_out (@costelmoraru) - [#265](https://github.com/pusher/oauth2_proxy/pull/265) Add upstream with static response (@cgroschupp) +- [#317](https://github.com/pusher/oauth2_proxy/pull/317) Add build for FreeBSD (@fnkr) - [#296](https://github.com/pusher/oauth2_proxy/pull/296) Allow to override provider's name for sign-in page (@ffdybuster) # v4.0.0 diff --git a/README.md b/README.md index daae04cc..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. +Please see our [Contributing](CONTRIBUTING.md) guidelines. For releasing see our [release creation guide](RELEASE.md). diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..1dc9b888 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,47 @@ +# 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 [CHANGELOG.md](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 --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. 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 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) diff --git a/dist.sh b/dist.sh index e5be8180..c161ac32 100755 --- a/dist.sh +++ b/dist.sh @@ -14,7 +14,7 @@ if [[ ! "${GO_VERSION}" =~ ^go1.13.* ]]; then exit 1 fi -ARCHS=(darwin-amd64 linux-amd64 linux-arm64 linux-armv6 windows-amd64) +ARCHS=(darwin-amd64 linux-amd64 linux-arm64 linux-armv6 freebsd-amd64 windows-amd64) mkdir -p release @@ -37,7 +37,7 @@ for ARCH in "${ARCHS[@]}"; do cd release # Create sha256sum for architecture specific binary - shasum -a 256 ${BINARY}-${VERSION}.${ARCH}.${GO_VERSION}/${BINARY} > ${BINARY}-${VERSION}.${ARCH}-sha256sum.txt + sha256sum ${BINARY}-${VERSION}.${ARCH}.${GO_VERSION}/${BINARY} > ${BINARY}-${VERSION}.${ARCH}-sha256sum.txt # Create tar file for architecture specific binary tar -czvf ${BINARY}-${VERSION}.${ARCH}.${GO_VERSION}.tar.gz ${BINARY}-${VERSION}.${ARCH}.${GO_VERSION}