Skip to content
This repository has been archived by the owner on May 5, 2024. It is now read-only.

Breaking changes from PR message #570

Open
spring1843 opened this issue Nov 26, 2022 · 0 comments
Open

Breaking changes from PR message #570

spring1843 opened this issue Nov 26, 2022 · 0 comments

Comments

@spring1843
Copy link

I'm seeing in the code that there is some functionality for breaking changes:

parsedCommitMsg.extra.breakingChange = isBreakingChange({

And here's the function that checks for breaking changes.

export const isBreakingChange = ({body, footer}: {body: string; footer: string}): boolean => {

However I'm having a hard time making it work from PRs. We want to have some instructions for PRs that introduce breaking changes so that the notes are properly reflected in release notes.

I was able to make this work by directly committing to the main branch (here https://github.com/spring1843/karpenter/releases/tag/v0.101.126), but unable to make it work in a PR.

So the question is, where should the message BREAKING CHANGE: description be entered in the context of the PR?

Is it the PR title? The PR description body? The last line of the PR description body (i.e. footer)?

Or is it the title, body, footer of the commit you create when you merge a PR?

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

No branches or pull requests

1 participant