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

Add feature release_notes to generate release notes #137

Merged
merged 4 commits into from
Nov 1, 2019

Conversation

alexellis
Copy link
Owner

Description

This feature enables notes to be collected from all merged/closed
PRs since the last release. The notes are then set/saved on the
release body field.

Motivation and Context

Closes: #89

How Has This Been Tested?

Tested in a console application outside of Derek and e2e with
Derek operating against the openfaas/org-tester repo.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Users must opt-in to use this feature, but it requests new permissions:

  • events: release
  • write to repository contents

User guide has been updated, to get this feature add release_notes under features: in .DEREK.yml

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.
  • All new and existing tests passed.

This feature enables notes to be collected from all merged/closed
PRs since the last release. The notes are then set/saved on the
release body field.

Tested in a console application outside of Derek and e2e with
Derek operating against the openfaas/org-tester repo.

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
Describes the new feature for release_notes and why the new
permissions are required.

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
Documents logic and adds tests for the basic scenarios.

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
Tests help show the bounding behaviour when only one release
is present.

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
@alexellis alexellis changed the title Generate release notes Add feature release_notes to generate release notes Nov 1, 2019
@alexellis alexellis merged commit 6d9b47f into master Nov 1, 2019
@alexellis alexellis deleted the openfaasltd/generate-release-notes branch November 1, 2019 15:35
@alexellis
Copy link
Owner Author

GitHub behaviour:

Screenshot 2019-11-01 at 15 35 54

With Derek's feature enabled:

Screenshot 2019-11-01 at 15 35 59

@alexellis
Copy link
Owner Author

Notifying ".CUSTOMERS"

moby - @thaJeztah PTAL
@rgee0
Subsurface-divelog @neolit123 @dirkhh PTAL
@ewilde PTAL
@colin-mccarthy PTAL
goreleaser @caarlos0 PTAL
evilsocket @caquino PTAL

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.

Derek to populate release notes from matching PRs/Issues with milestone
1 participant