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

chore: Update CHANGELOG implementation #2470

Merged
merged 1 commit into from
May 28, 2021
Merged

Conversation

embano1
Copy link
Contributor

@embano1 embano1 commented May 28, 2021

Description

This PR updates the CHANGELOG and release notes generation process and layout:

  • Use different templates for release notes (shown in Github Release) and CHANGELOG.md
    • Release notes will now include issue references in commit lines (when available, detected with Closes or Fixes pattern matching)
    • CHANGELOG.md will not include issue references in output
  • Include additional highlights for documentation, examples, and bug fixes
  • Update CONTRIBUTING guide to explain how to use these prefixes
  • Add BREAKING changes section to release notes/CHANGELOG, detected when using BREAKING: in commit message body
  • Build, Docker login and release workflow can now be triggered manually (dispach)
  • Updated CHANGELOG.md with changes
  • CHANGELOG.md as part of a release does not have to be created manually anymore (bot will create PR)

Closes: #2467
Signed-off-by: Michael Gasch mgasch@vmware.com

Example of rendered Release Notes

Release v0.26.0

Release Date: 2021-05-28

🐞 Fix

💡 Examples

💫 govc (CLI)

💫 vcsim (Simulator)

📃 Documentation

Example highlighting Breaking Changes

⚠️ BREAKING

remove ctx from param

func (removed context.Context) error {...}

Type of change

Please mark options that are relevant:

  • 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
    not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. If applicable, please also list any relevant
details for your test configuration.

  • Test Description 1
  • Test Description 2

Test Configuration:

  • Toolchain:
  • SDK:
  • (add more if needed)

Checklist:

  • My code follows the CONTRIBUTION guidelines of
    this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged

Closes: vmware#2467
Signed-off-by: Michael Gasch <mgasch@vmware.com>
Copy link
Member

@dougm dougm left a comment

Choose a reason for hiding this comment

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

Awesome @embano1

@embano1 embano1 merged commit 5395233 into vmware:master May 28, 2021
@embano1 embano1 deleted the issue-2467 branch May 28, 2021 18:45
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve CHANGELOG
3 participants