ansys / actions

A collection of reusable workflows
https://actions.docs.ansys.com/
MIT License
13 stars 5 forks source link

feat: doc-changelog conventional commits #515

Closed klmcadams closed 3 months ago

klmcadams commented 3 months ago

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: true line 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

ansys-reviewer-bot[bot] commented 3 months ago

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

@ansys-reviewer-bot review