prefect icon indicating copy to clipboard operation
prefect copied to clipboard

feat: Add automatic changelog generation (WIP)

Open zangell44 opened this issue 2 years ago • 2 comments

Summary

With all the work done on the prefect codebase, it can be tough to track and summarize the changes that have been made.

This PR adds automatic changelog generation based on PR titles. Each PR title must match the expected format: "change-type: description of change"

Valid change types are:

  • feat
  • enhancement
  • fix
  • deprecation
  • breaking (for breaking changes)

After a pull request is merged, a yaml file is written to .changes/. When it's time to write release notes, prefect dev release-notes uses these yaml files to update RELEASE-NOTES.md.

TODO

  • [ ] Workflow to write changes file on merge (this is written but failing when I test with actual PRs, I think there's some permissions that need to be fixed)
  • [ ] Include labels of merged PRs in the description

Steps Taken to QA Changes

Checklist

This pull request is:

  • [ ] A documentation / typographical error fix
    • No tests or issue needed
  • [x] A short code fix
    • Please reference the related issue by including "closes <link to issue>" in this Pull Request's summary section.
      • If no issue exists, please create a bug report issue
    • Please include tests. One-line fixes without tests will not be accepted unless it's related to the documentation only.
  • [ ] A new feature implementation
    • Please reference the related issue by including "closes <link to issue>" in this Pull Request's summary section.
      • If no issue exists, please create a feature enhancement issue
    • Please include tests
    • Please make sure that your QA steps are both thorough and easy to reproduce by somebody with limited knowledge of the feature that you are submitting

Happy engineering!

zangell44 avatar Aug 08 '22 01:08 zangell44

@zangell44 Can we use labels since you're retrieving the pull request anyway?

zanieb avatar Aug 08 '22 15:08 zanieb

Thanks a ton for solving for this @zangell44 - I really like this approach!

billpalombi avatar Aug 08 '22 19:08 billpalombi