-
Notifications
You must be signed in to change notification settings - Fork 7
refactor: use-pull-request-title instead of use-conventional-commits
#962
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
base: main
Are you sure you want to change the base?
refactor: use-pull-request-title instead of use-conventional-commits
#962
Conversation
…f conventional commits
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors the doc-changelog action by renaming the use-conventional-commits input parameter to use-pull-request-title for better clarity while maintaining backward compatibility.
- Renamed the input parameter
use-conventional-commitstouse-pull-request-title - Added deprecation support for the old parameter with error logging
- Updated all references throughout the codebase and documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/source/doc-actions/examples/doc-changelog-basic.yml | Updated example configuration to use new parameter name |
| doc-changelog/action.yml | Renamed input parameter and added backward compatibility with deprecation warning |
| .github/workflows/ci_cd_pr.yml | Updated workflow to use new parameter name |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
RobPasMue
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this just a renaming? Just trying to understand.
SMoraisAnsys
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreeing with @RobPasMue comment, we should log a warning in current major (v10), switch to an error with v11 and remove everything in v12. Below is an example of what was performed when releasing v10 (warning on v9 if I'm not wrong)
- uses: ansys/actions/_logging@main
if: inputs.toml-version != ''
with:
level: "ERROR"
message: >
With the adoption of dependency groups in PyAnsys packages, the ``toml`` library
is no longer used because it cannot parse ``pyproject.toml`` files where groups
include other groups. This action now uses the ``tomli`` library instead. If you
want to use a specific version of ``tomli``, please set the ``tomli-version``
input accordingly. The ``toml-version`` input will be removed in v11.
…ing-use-conventional-commits-to-use-pr-title
…tle' of https://github.com/pyansys/actions into refactor/renaming-use-conventional-commits-to-use-pr-title
…v12 and change logging level to WARNING
…PULL_REQUEST_TITLE and switch step conditionals to use env var
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…onditionals and PR title mapping
…TITLE and rename clean_pr_title parameter
…nputs to USE_PULL_REQUEST_TITLE
…d use in conditionals
Co-authored-by: Jorge Martínez <[email protected]>
…al-commits deprecation warning
SMoraisAnsys
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just a minor suggestion
| want to use a specific version of ``tomli``, please set the ``tomli-version`` | ||
| input accordingly. The ``toml-version`` input will be removed in v11. | ||
| - uses: ansys/actions/_logging@main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a comment here to not miss the need from switch warning -> error at some point ?
I like the # TODO: ... note and the use of [DEPRECATED] as it would ease finding such location.
This PR is just proposing to use a different name for the argument
use-conventional-commits.Currently, if
use-conventional-commitsis not set, the categorization of the PRs on the Changelog.md is based on the labels. Ifuse-conventional-commitsis set, then the categorization is given by the commit prefix.I propose to use
use-pull-request-titlewhich is more clear about its usage.