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

contrib: Add simplified version of Kubernetes relnotes script #1893

Merged
merged 1 commit into from
Oct 30, 2017

Conversation

tgraf
Copy link
Member

@tgraf tgraf commented Oct 30, 2017

This allows to automatically extract the release notes from the list of
merged PRs based on PR labels and special release-note blocks in the
body of the PR.

The relnotes script is derived from Kubernetes and scans for PRs which have been merged in the specified git revision range and extracts all PRs which have one of the following labels set:

  • release-note/major
  • release-note/minor
  • release-note/bug

Extensive documentation on how to use this will be submitted in separate PR covering the contribution guidelines.

Example:

# v0.12

Major Changes:

Bugfixes Changes:
* Test for release note (#1681, @joestringer)
    * fooo
Introduction of release notes gathering script in use by the Kubernetes project

@tgraf tgraf added the wip label Oct 30, 2017
@tgraf tgraf requested a review from a team as a code owner October 30, 2017 14:37
@tgraf tgraf force-pushed the release-notes branch 2 times, most recently from 0c33fa0 to 1394100 Compare October 30, 2017 14:39
@tgraf tgraf added pending review and removed wip labels Oct 30, 2017
@tgraf tgraf requested a review from a team October 30, 2017 14:47
@ianvernon ianvernon self-requested a review October 30, 2017 15:17
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

It might be worth mentioning in the PR or commit message that it seems you can set GITHUB_TOKEN in your environment rather than specifying the token on the commandline every time.

LGTM

This allows to automatically extract the release notes from the list of
merged PRs based on PR labels and special release-note blocks in the
body of the PR.

Signed-off-by: Thomas Graf <thomas@cilium.io>
@tgraf
Copy link
Member Author

tgraf commented Oct 30, 2017

It might be worth mentioning in the PR or commit message that it seems you can set GITHUB_TOKEN in your environment rather than specifying the token on the commandline every time.

Addressed in README

@tgraf tgraf added the release-note/minor This PR changes functionality that users may find relevant to operating Cilium. label Oct 30, 2017
@tgraf tgraf merged commit 1b8cb62 into master Oct 30, 2017
@tgraf tgraf deleted the release-notes branch October 30, 2017 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note/minor This PR changes functionality that users may find relevant to operating Cilium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants