From 71c24f954eedd397f5d7e5572c8420a5c2abf131 Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Wed, 30 May 2018 09:36:27 -0700 Subject: [PATCH] Update to release process This PR includes: - small fixes to the release process that came up during the last release - Adding links to the release process from the main README - Including a release calendar that people can see. --- README.md | 2 ++ docs/governance/release_process.md | 5 +++-- docs/governance/templates/release.md | 2 +- docs/governance/templates/release_issue.md | 11 +++++++---- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b09636c9d3..ad44fd25bc 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,8 @@ Please read the [contributing](CONTRIBUTING.md) guide for directions on submitti See the [Developing, Testing and Building Agones](build/README.md) documentation for developing, testing and building Agones from source. +The [Release Process](docs/governance/release_process.md) documentation displays the project's upcoming release calendar and release process. + Agones is in active development - we would love your help in shaping its future! ## This all sounds great, but can you explain Kubernetes to me? diff --git a/docs/governance/release_process.md b/docs/governance/release_process.md index 2be31e7095..884f0e5516 100644 --- a/docs/governance/release_process.md +++ b/docs/governance/release_process.md @@ -12,12 +12,13 @@ ## Release Calendar -> Release Calendar forthcoming once the 0.2.0 release is complete, when the scheduled release cadence will start. +- [Web View](https://calendar.google.com/calendar/embed?src=google.com_828n8f18hfbtrs4vu4h1sks218%40group.calendar.google.com&ctz=America%2FLos_Angeles) +- [iCal](https://calendar.google.com/calendar/ical/google.com_828n8f18hfbtrs4vu4h1sks218%40group.calendar.google.com/public/basic.ics) # Release Process 1. Create a Release Issue from the [release issue template](./templates/release_issue.md). -1. Label the issue `release`, and attach it to the milestone that it matches. +1. Label the issue `kind/release`, and attach it to the milestone that it matches. 1. Complete all items in the release issue checklist. 1. Close the release issue. diff --git a/docs/governance/templates/release.md b/docs/governance/templates/release.md index b36c55b738..8bd26ae1f8 100644 --- a/docs/governance/templates/release.md +++ b/docs/governance/templates/release.md @@ -8,7 +8,7 @@ Features in this release: { insert enhancements from the changelog } -See [CHANGELOG.md](https://github.com/GoogleCloudPlatform/agones/blob/{release-branch}/CHANGELOG.md) for more details on changes. +See [CHANGELOG](https://github.com/GoogleCloudPlatform/agones/blob/{release-branch}/CHANGELOG.md) for more details on changes. This software is currently alpha, and subject to change. Not to be used in production systems. diff --git a/docs/governance/templates/release_issue.md b/docs/governance/templates/release_issue.md index 7ce6d7c5b6..5f2084280e 100644 --- a/docs/governance/templates/release_issue.md +++ b/docs/governance/templates/release_issue.md @@ -11,13 +11,15 @@ and copy it into a release issue. Fill in relevent values, found inside {} - [ ] Any issues in the current milestone that are not closed, move to next milestone. - [ ] Run `make gen-changelog` to generate the CHANGELOG.md - [ ] Ensure the [helm `tag` value][values] is correct (should be the {version} if a full release, {version}.rc if release candidate) -- [ ] Remove all instances of "⚠️⚠️⚠️ **This is currently a development feature and has not been released** ⚠️⚠️⚠️" +- [ ] Run `make gen-install` +- [ ] If RC release, update all ⚠️⚠️⚠️ warnings to: "**This is currently a release candidate feature**" +- [ ] If full release, remove all instances of "⚠️⚠️⚠️ **This is currently a development feature and has not been released** ⚠️⚠️⚠️" - [ ] If full release, update install docs with the new release version - [ ] Create PR with these changes, and merge them with approval -- [ ] If full release, close the current milestone. - [ ] Confirm local git remote `upstream` points at `git@github.com:GoogleCloudPlatform/agones.git` - [ ] Run `git checkout master && git reset --hard upstream/master` to ensure your code is in line with upstream (unless this is a hotfix, then do the same, but for the the release branch) - [ ] Run `make do-release`. (if release candidate `make do-release RELEASE_VERSION={version}.rc`) to create and push the docker images. +- [ ] Do a `helm install` and a smoke test to confirm everything is working. - [ ] Create a release with the [release template][release-template] - [ ] Make a `tag` with the release version. - [ ] Attach all assets found in the `release` folder to the release. @@ -25,9 +27,10 @@ and copy it into a release issue. Fill in relevent values, found inside {} - [ ] If full release, then increment the `base_version` in [`build/Makefile`][build-makefile] - [ ] Ensure the [the helm `tag` value][values] is the same as the above `base_version` - [ ] Create PR with these changes, and merge them with approval -- [ ] Close this issue. *Congratulations!* - the release is now complete! :tada: :clap: :smile: :+1: +- [ ] Close this issue. +- [ ] If full release, close the current milestone. *Congratulations!* - the release is now complete! :tada: :clap: :smile: :+1: [values]: https://github.com/GoogleCloudPlatform/agones/blob/master/install/helm/agones/values.yaml#L33 [list]: https://groups.google.com/forum/#!forum/agones-discuss [release-template]: https://github.com/GoogleCloudPlatform/agones/blob/master/docs/governance/templates/release.md -[build-makefile]: https://github.com/GoogleCloudPlatform/agones/blob/master/build/Makefile +[build-makefile]: https://github.com/GoogleCloudPlatform/agones/blob/master/build/Makefile \ No newline at end of file