Skip to content

Conversation

@germa89
Copy link
Contributor

@germa89 germa89 commented Aug 25, 2025

This PR is just proposing to use a different name for the argument use-conventional-commits.

Currently, if use-conventional-commits is not set, the categorization of the PRs on the Changelog.md is based on the labels. If use-conventional-commits is set, then the categorization is given by the commit prefix.

I propose to use use-pull-request-title which is more clear about its usage.

@germa89 germa89 requested a review from a team as a code owner August 25, 2025 10:25
@germa89 germa89 self-assigned this Aug 25, 2025
@germa89 germa89 requested review from Copilot and klmcadams August 25, 2025 10:25
@github-actions github-actions bot added the ci Pipelines maintenance related label Aug 25, 2025
Copy link

Copilot AI left a 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-commits to use-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.

Copy link
Member

@RobPasMue RobPasMue left a 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.

Base automatically changed from style/changelog-improvements to main August 25, 2025 12:44
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a 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.

Copy link

Copilot AI left a 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.

Co-authored-by: Jorge Martínez <[email protected]>
@moe-ad moe-ad added this to the ansys/[email protected] milestone Oct 21, 2025
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a 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
Copy link
Contributor

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.

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

Labels

ci Pipelines maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants