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

Signify breaking change in output #273

Open
Idane opened this issue Jul 3, 2024 · 1 comment
Open

Signify breaking change in output #273

Idane opened this issue Jul 3, 2024 · 1 comment

Comments

@Idane
Copy link

Idane commented Jul 3, 2024

Is your feature request related to a problem? Please describe.

When using an exclamation mark to trigger a breaking change, it passes validation. However, the outputs lack an indication that the title represent a breaking change, and even remove the exclamation mark from feat:

feat!: do major release

Outputs:

{
  "type": "feat",
  "scope": "",
  "subject": "do major release"
}

Describe the solution you'd like

Add a breakingChange boolean output

Describe alternatives you've considered

@amannn
Copy link
Owner

amannn commented Jul 3, 2024

This action uses conventional-commits-parser to parse the PR title and subsequently populates the output:

const result = parser(prTitle, parserOpts);
core.setOutput('type', result.type);
core.setOutput('scope', result.scope);
core.setOutput('subject', result.subject);

Currently the parser doesn't return any information of whether it's a breaking change. If this information is available upstream in the parser, we could return it to an output.

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

No branches or pull requests

2 participants