Skip to content

Conversation

@SMoraisAnsys
Copy link
Contributor

Adds checking for breaking change in the PR title and body. On repos following conventionnal commits, this will greatly help:

  • users to know what breaking changes are introduced in a specific version;
  • developers to have an idea of how often they are breaking their API.

I think that this could be used as a metric to know whether a repo is ready to move to version 1.0.0

Close #722

@SMoraisAnsys SMoraisAnsys requested a review from a team as a code owner May 10, 2025 12:09
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added enhancement General improvements to existing features docs Issues related to documentation labels May 10, 2025
@SMoraisAnsys SMoraisAnsys changed the title feat: Add breaking change section feat: add breaking change section May 10, 2025
@github-actions github-actions bot added the ci Pipelines maintenance related label May 10, 2025
@RobPasMue
Copy link
Member

RobPasMue commented May 10, 2025

Hmmm... Weren't breaking changes done as feat!:...

Can't access easily the conventional commits site (security issue apparently) but see https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#breaking-changes-indicator


EDIT - just saw that you are handling this case too... I overlooked it, sorry!

@SMoraisAnsys SMoraisAnsys marked this pull request as draft May 12, 2025 08:26
@jorgepiloto jorgepiloto added this to the ansys/actions@v10 milestone May 13, 2025
@RobPasMue
Copy link
Member

What's the status here @SMoraisAnsys? I think @jorgepiloto is planning on doing the release tomorrow or Wednesday latest.

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

Labels

ci Pipelines maintenance related docs Issues related to documentation enhancement General improvements to existing features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add breaking changes to the changelog

6 participants