Skip to content

feat(breakingchange): ✨ add breaking change configuration#101

Open
yi-Xu-0100 wants to merge 1 commit intovivaxy:masterfrom
yi-Xu-0100:add-breaking-change-prompt
Open

feat(breakingchange): ✨ add breaking change configuration#101
yi-Xu-0100 wants to merge 1 commit intovivaxy:masterfrom
yi-Xu-0100:add-breaking-change-prompt

Conversation

@yi-Xu-0100
Copy link
Copy Markdown
Collaborator

@yi-Xu-0100 yi-Xu-0100 commented Mar 24, 2021

  1. add detectBreakingChange option.
  2. add promptBreakingChange option.
  3. add breakingChangeFormat option.
  4. fix the prompt context retaining issue.

close #39, close #100

@yi-Xu-0100 yi-Xu-0100 requested a review from vivaxy March 24, 2021 08:54
@yi-Xu-0100 yi-Xu-0100 added the wait-to-build PR wait to build package. label Mar 24, 2021
@github-actions
Copy link
Copy Markdown
Contributor

The beta extension of this pull has been built in the workflow! 🎉
Download vscode-conventional-commits-10f57b7.vsix in artifacts. 🚀

Copy link
Copy Markdown
Owner

@vivaxy vivaxy left a comment

Choose a reason for hiding this comment

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

👍 That's a lot work done here. I'd like to test it for some time.

@yi-Xu-0100
Copy link
Copy Markdown
Collaborator Author

@vivaxy I test many times today and will use it in the future for some time. During the test, I found the bug (#100). I try to delete the export function and use the constructor in the prompt function to fix the bug.

I do not why it can work, but it fixes the issue. Maybe we can make this little commit merge into master and make a patch firstly. See more in (#100) and the commit (326c953). 😀

package.nls.json Outdated
"extension.sources.prompt.breakingChange.placeholder": "Select a way to add breaking changes of this change.",
"extension.sources.prompt.breakingChange.noneItem.label": "None",
"extension.sources.prompt.breakingChange.noneItem.detail": "No breaking change.",
"extension.sources.prompt.breakingChange.pointItem.label": "! (point mode)",
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Why is this called point mode?

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Maybe it can be called as Breaking change in header.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

! exclamation mark (英式英语) / point (美式英语)

I misunderstood it. The exclamation point may be correct. 😅

I will use Breaking change in header, Breaking change in footer and Breaking change as token in footer for the labels of them.

@vivaxy
Copy link
Copy Markdown
Owner

vivaxy commented Mar 24, 2021

@vivaxy I test many times today and will use it in the future for some time. During the test, I found the bug (#100). I try to delete the export function and use the constructor in the prompt function to fix the bug.

I do not why it can work, but it fixes the issue. Maybe we can make this little commit merge into master and make a patch firstly. See more in (#100) and the commit (326c953). 😀

Maybe because commitMessage is in singleton, and the extension does not exit after committing. We can check the output to make sure. If so, it's a nice fix.

1. add `detectBreakingChange` option.
2. add `promptBreakingChange` option.
3. add two `breakingChangeFormat`.
@yi-Xu-0100 yi-Xu-0100 force-pushed the add-breaking-change-prompt branch from a42c75b to 21f24f5 Compare April 13, 2021 05:01
@silopolis
Copy link
Copy Markdown

Any chance of this getting merged someday ?

@vladly
Copy link
Copy Markdown

vladly commented May 10, 2023

Please add this feature

@yi-Xu-0100
Copy link
Copy Markdown
Collaborator Author

yi-Xu-0100 commented May 26, 2023

👋 @silopolis @vladly I'm glad you noticed this issue. It hasn't been updated in a long time, and fixing it will require some time. Currently, I don't have the leisure time to address this problem. If you have any ideas, you can submit a pull request to help with the development. 😊

Moreover, due to the long-term use of the extension, frequent commits with disruptive changes are unreasonable. Therefore, this pull request has been put on hold and considered a low-priority feature. 🤔

@leonardvgend
Copy link
Copy Markdown

Hello, if I understand correctly, this change will autmoatically add "BREAKING CHANGE: " when the user enters their breaking change into this prompt?

image

If so, this would be an amazing feature! I actually expected it to work like that already, and I thought something might be wrong with my configs.

@sag1v
Copy link
Copy Markdown

sag1v commented Feb 12, 2024

Hi, is this going to be merged soon?

@philipp-winterle
Copy link
Copy Markdown

As this is part of Conventional Commits as a schema BREAKING CHANGE is a mandatory feature to be in line with the defaults. I would not consider this as a low prio feature.

With this extension no major release would be possible if not done manual

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.

[FEAT] automatically prepend BREAKING CHANGE: [BUG] If the promptScopes changed, the context of scope will be retained

7 participants