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

Categorise breaking-change labels in release notes #13201

Merged
merged 4 commits into from
Mar 20, 2025

Conversation

dacook
Copy link
Member

@dacook dacook commented Mar 11, 2025

What? Why?

https://openfoodnetwork.slack.com/archives/C01T75H6G0Z/p1741668548086439

  • Create two new labels for PRs, to signal when it contains a “breaking change” which requires a major or minor version increment (the X or Y in vX.Y.Z).
    • The release template will be updated to categorise these
  • In the future, consider creating a PR for the weekly Transifex update.
    • This means we can draft the release based on the PR’s last commit (and view the labels, before assigning the version number.

When a release is drafted, it should be easy to see if it contains any breaking changes, so we can set the version number accordingly.

What should we test?

We could test this after merging, by assigning the labels to a recently merged PR and draft a release.
Don't forget to remove the labels after testing!

Documentation updates

https://github.com/openfoodfoundation/openfoodnetwork/wiki/Releasing

  • mention this when choosing a version number

@dacook dacook added the technical changes only These pull requests do not contain user facing changes and are grouped in release notes label Mar 11, 2025
@dacook dacook self-assigned this Mar 11, 2025
Copy link
Member

@mkllnk mkllnk left a comment

Choose a reason for hiding this comment

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

Nice. Just wondering about the label naming.

Much less alarming than 'breaking'.
@dacook dacook added the major breaking change A significant change requiring a major version increment label Mar 20, 2025
The labels on GitHub have already been updated.

[skip ci]
@dacook dacook force-pushed the breaking-change-labels branch from fc5a26b to da3bd4e Compare March 20, 2025 04:31
@dacook dacook requested a review from mkllnk March 20, 2025 04:32
Copy link
Member

@mkllnk mkllnk left a comment

Choose a reason for hiding this comment

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

Great. I'll merge and we can test this with the new release.

@mkllnk mkllnk merged commit c60bb27 into openfoodfoundation:master Mar 20, 2025
@dacook dacook removed the major breaking change A significant change requiring a major version increment label Mar 23, 2025
@dacook
Copy link
Member Author

dacook commented Mar 23, 2025

Note that the release notes generator will choose only one category for a PR. If it has two labels, it gets put in the first category.
This means that a "significant changes" PR won't also appear in another category. I guess we can choose to manually copy it in there as needed.

Screenshot 2025-03-24 at 10 22 57 am

@mkllnk
Copy link
Member

mkllnk commented Mar 24, 2025

Note that the release notes generator will choose only one category for a PR.

Interesting. I didn't know that. So if we put Uncategorised at the bottom then we wouldn't need the exclude list for all the labels. I like it at the top though. We can keep it as is. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical changes only These pull requests do not contain user facing changes and are grouped in release notes
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants