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

[Dev] Prompt whether an issue should be labeled as Breaking Change when merging #38841

Open
raulcd opened this issue Nov 22, 2023 · 3 comments
Open

Comments

@raulcd
Copy link
Member

raulcd commented Nov 22, 2023

Describe the enhancement requested

Currently is rather difficult to know whether a commit contains a Breaking Change or not and this is done by manually tagging the issue with the Breaking Change label.
We added the PR template which prompts whether there are user-facing changes or not. I think we should modify our merge script to prompt whether the breaking change label has to be added on the issue when merging a PR.

Once this is done we could modify our Release Changelog to add a section of Breaking changes that could help users identify breaking changes for newer versions.

Component(s)

Developer Tools

@amoeba
Copy link
Member

amoeba commented Nov 22, 2023

This is great, thanks @raulcd. Are all commits on main made using the merge script or do some maintainers use other mechanisms such as the GitHub UI? I would want any prompt to apply everywhere if possible.

@raulcd
Copy link
Member Author

raulcd commented Nov 22, 2023

All commits via PR are merged with the merge script. We do not use the GitHub UI. The only commits that are pushed directly to main are the bump versions after a release but those are not relevant for this.

@amoeba
Copy link
Member

amoeba commented Nov 22, 2023

Great, thanks.

We might want another ticket for this idea but would it be possible to update out GitHub workflows so the breaking change label is copied from PR to issue? In the case of #35656, the label was added to the PR but not the issue which seems like a totally reasonable thing to have done so it'd be nice if we could automate that problem away.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants