Skip to content

feat: add breaking change section#1117

Merged
jorgepiloto merged 17 commits intomainfrom
feat/add-breaking-change-section
Jan 27, 2026
Merged

feat: add breaking change section#1117
jorgepiloto merged 17 commits intomainfrom
feat/add-breaking-change-section

Conversation

@SMoraisAnsys
Copy link
Copy Markdown
Contributor

@SMoraisAnsys SMoraisAnsys commented Jan 22, 2026

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.

Extra change: reordering of the towncrier types to a (very) subjective priority list. Seems that the order in which the changes are displayed is following the pyproject.toml / towncrier.toml file data.

Close #722

Follow up of #810


Working tests performed:

The release only contains one of the PR (I forgot the other) and does not contain the reordering which was performed in this PR

@SMoraisAnsys SMoraisAnsys requested a review from a team as a code owner January 22, 2026 10:03
@SMoraisAnsys SMoraisAnsys marked this pull request as draft January 22, 2026 10:03
@github-actions github-actions Bot added enhancement General improvements to existing features ci Pipelines maintenance related docs Issues related to documentation labels Jan 22, 2026
@SMoraisAnsys
Copy link
Copy Markdown
Contributor Author

Updating title with "!" to verify the label change

@SMoraisAnsys SMoraisAnsys changed the title feat: add breaking change section feat!: add breaking change section Jan 23, 2026
@SMoraisAnsys
Copy link
Copy Markdown
Contributor Author

Success. Changing back to feat: .... and adding "Breaking Change: ...." into the PR body

@SMoraisAnsys SMoraisAnsys changed the title feat!: add breaking change section feat: add breaking change section Jan 23, 2026
@SMoraisAnsys
Copy link
Copy Markdown
Contributor Author

Modifying the PR content

Copy link
Copy Markdown
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

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

Why are we checking the body of the pull-reques? I thought we were checking only its title.

@SMoraisAnsys SMoraisAnsys self-assigned this Jan 26, 2026
@SMoraisAnsys
Copy link
Copy Markdown
Contributor Author

Why are we checking the body of the pull-reques? I thought we were checking only its title.

We could restrict this kind of checking to the title only. However, the current changes align with the conventional commit convention which also checks for breaking change footer. This is related to git trailers but I don't think we should go through all the commits of a PR to check if a commit contains a breaking change. Since most of the repo merge the PR description into main, I think it make more sense to only check the PR title and body.

@SMoraisAnsys SMoraisAnsys marked this pull request as ready for review January 27, 2026 08:43
@jorgepiloto jorgepiloto merged commit 8f05846 into main Jan 27, 2026
45 checks passed
@jorgepiloto jorgepiloto deleted the feat/add-breaking-change-section branch January 27, 2026 14:38
@jorgepiloto jorgepiloto added this to the ansys/actions@v10.3 milestone Jan 27, 2026
@moe-ad moe-ad removed this from the ansys/actions@v10.3 milestone Feb 24, 2026
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

4 participants