Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document and extend release process #434

Merged
merged 3 commits into from
Jul 15, 2021
Merged

Conversation

tklauser
Copy link
Member

Document the current release process and slightly extend it in two ways:

  • Add (and keep updated) a stable.txt file which always points to the latest stable version of Cilium CLI.
  • Create automated releases as draft, create a changelog as part of the release process and let the maintainers publish the release after updating it with the changelog.

See individual commits for details.

Fixes #363

tklauser added 2 commits July 15, 2021 12:31
Follow Cilium and Hubble and add a stable.txt file in the
master branch that always points to the latest stable release of the
Cilium CLI.

This file can be used e.g. in Cilium CI to always get the latest stable
release version.

Suggested-by: Robin Hahling <[email protected]>
Signed-off-by: Tobias Klauser <[email protected]>
With the updated release procedure, we'll add release notes manually
(see next commit). Thus, let the GitHub action create a draft release
which will then be published by a maintainer after adding the changelog.

Signed-off-by: Tobias Klauser <[email protected]>
@tklauser tklauser requested review from a team as code owners July 15, 2021 10:31
@tklauser tklauser requested review from nebril and nbusseneau July 15, 2021 10:31
@tklauser tklauser temporarily deployed to ci July 15, 2021 10:31 Inactive
RELEASE.md Outdated Show resolved Hide resolved
RELEASE.md Outdated Show resolved Hide resolved
@tklauser tklauser force-pushed the pr/tklauser/release-doc branch from 14a6228 to 0842eb7 Compare July 15, 2021 13:33
@tklauser tklauser temporarily deployed to ci July 15, 2021 13:33 Inactive
Document the release process for Cilium CLI. Instructions are based on
`RELEASE.md` in the Hubble repo.

Note that in addition to the the releases so far, we also update
`stable.txt` and publish the changelog in the release notes.

Signed-off-by: Tobias Klauser <[email protected]>
@tklauser tklauser force-pushed the pr/tklauser/release-doc branch from 0842eb7 to e404944 Compare July 15, 2021 14:09
@tklauser tklauser temporarily deployed to ci July 15, 2021 14:09 Inactive
Copy link
Member

@nbusseneau nbusseneau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Thoughts: I'm thinking we could automate almost everything in there. Full process could be:

  • A workflow that needs to be manually triggered, passing in version parameters. When triggered:
    • Prepare release notes.
    • Update stable.txt and VERSION.
    • Push branch and create PR.
  • Then, another workflow running on push to master:
    • Identify that a release PR just got merged (file names filtering? commit names? PR name?)
    • Tag using version from PR
    • Create GH release using release notes from PR

@tklauser
Copy link
Member Author

Thanks @nbusseneau! I've created #435 based on your comment #434 (review) so we don't forget to address it.

@tklauser tklauser merged commit d19efde into master Jul 15, 2021
@tklauser tklauser deleted the pr/tklauser/release-doc branch July 15, 2021 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document release process
5 participants