Skip to content

Commit

Permalink
Update to release process
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
markmandel committed Jun 1, 2018
1 parent 045f774 commit 71c24f9
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
5 changes: 3 additions & 2 deletions docs/governance/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/governance/templates/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
11 changes: 7 additions & 4 deletions docs/governance/templates/release_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,26 @@ 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.
- [ ] Send an email to the [mailing list][list] with the release details (copy-paste the github release)
- [ ] 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

0 comments on commit 71c24f9

Please sign in to comment.