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 sample CHANGELOG and changelog generation/update script #997

Closed
wants to merge 6 commits into from

Conversation

iajoiner
Copy link
Contributor

@iajoiner iajoiner commented Dec 6, 2022

Description

Add a sample CHANGELOG.md as well as the script that generates/updates CHANGELOG.md and CHANGELOG-old.md

Closes #996.

Features:

  1. Contributions with the label "dependencies" which are abundant, are always made by dependabot and are not very useful in a changelog have been ignored.
  2. Ignore tags with different languages (e.g. ignore any Python tag when producing the changelog from Rust 0.5.0 to Rust 0.6.0).

Features in future PRs:

  1. Filter out contributions that are from unrelated languages which will probably benefit from autolabelling of PRs.

roeap
roeap previously approved these changes Dec 7, 2022
Copy link
Collaborator

@roeap roeap left a comment

Choose a reason for hiding this comment

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

Really looking forward to doing more frequent, higher quality releases :), thanks!

You would have to rebase or merge once for me to trigger CI.

@roeap
Copy link
Collaborator

roeap commented Dec 8, 2022

@iajoiner - i was about to merge this, when i realized this would bump the rust version to 0.6.0 create the changlog for yet unreleased 0.6.0. Is this intentional? And if so, would the script update the log once we do the actual release?

@iajoiner
Copy link
Contributor Author

iajoiner commented Dec 8, 2022

@roeap This is really just a preview of what will happen once we do actually have a release. However we do need to add historical changelogs. In order for Python changes between a Python release and the Rust release after that to not be included into the Rust release and vice versa we need to get PR autolabeling done first.

@roeap
Copy link
Collaborator

roeap commented Dec 9, 2022

makes sense :) - i took the liberty to convert this to draft, hope that is OK.

@roeap roeap marked this pull request as draft December 9, 2022 06:35
@iajoiner
Copy link
Contributor Author

Once #1030 is merged I will improve this one.

@iajoiner iajoiner mentioned this pull request Dec 19, 2022
wjones127 pushed a commit that referenced this pull request Dec 19, 2022
# Description
The description of the main changes of your pull request

Use [labeler](https://github.com/actions/labeler) to automatically label
PRs. There are language labels, CI, documentation as well as
crate-specific labels.
# Related Issue(s)
<!---
For example:

- closes #106
--->
Closes #1026 & unblocks #997.
# Documentation

<!---
Share links to useful documentation
--->
@iajoiner iajoiner closed this Apr 14, 2023
@iajoiner iajoiner deleted the changelog-generator branch April 14, 2023 11:24
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.

Automatically generate and update changelogs
2 participants