feat: doc-changelog conventional commits #515
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
klmcadams
commented
Jul 9, 2024
RobPasMue
requested changes
Jul 10, 2024
klmcadams
commented
Jul 10, 2024
klmcadams
commented
Jul 11, 2024
…mit type (#529) Co-authored-by: Roberto Pastor Muela <[email protected]> Co-authored-by: Sébastien Morais <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By default, the doc-changelog action will check if there is a conventional commit type in the PR title (both lowercase and uppercase types are allowed). The conventional commit type is also removed from the titles that are placed in the towncrier fragment file. For example, if you have your PR title "fix: doc-changelog issue", then the towncrier fragment file's contents will only be "doc-changelog issue"
If you want to use labels to create the changelog fragment, you have to add the
use-labels: trueline to the doc-changelog job.This will break repositories until the pyproject.toml files are updated to include the additional sections listed in the doc-changelog documentation
Conventional commit tests:
Fails when there is no conventional commit type in the title
Passes when there is an all caps conventional commit type in the title
Passes when there is an all lowercase conventional commit type in the title
Labels tests:
Documentation label
Test label