feat: implementing `ansys/actions/changelogs` and adding release note in documentation

[clatapie]

Implementing release note in documentation, using ansys/actions/changelogs and https://github.com/ansys/pyansys-geometry/pull/1138.

[ansys-reviewer-bot[bot]]

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

@ansys-reviewer-bot review

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.17%. Comparing base (7c1eb1e) to head (7ada8b1). Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3019      +/-   ##
==========================================
- Coverage   86.63%   84.17%   -2.47%     
==========================================
  Files          52       52              
  Lines        9550     9550              
==========================================
- Hits         8274     8039     -235     
- Misses       1276     1511     +235     

[germa89]

Is this still a draft? @clatapie

[clatapie]

The changelog can be effective but I wanted to add some documentation about commit and branch name conventions. I also have planned to add the ansys/action that checks those names as pyansys-geometry does.

[clatapie]

I will resume it next week

[clatapie]

As the Contributing section in the PyAnsys dev guide details the naming conventions, adding the action should be enough to ensure a consistent changelog section. Pinging @germa89 for visibility.

[germa89]

For reference: https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions

Contributing — PyAnsys developer's guide

[germa89]

I realised that dependabot also has a prefix for the commits. You might need to adapt that one too.

https://github.com/ansys/pymapdl/blob/365563996bf10116ff3d0c2714fe364c39ac4b84/.github/dependabot.yml#L13

[clatapie]

I realised that dependabot also has a prefix for the commits. You might need to adapt that one too.

https://github.com/ansys/pymapdl/blob/365563996bf10116ff3d0c2714fe364c39ac4b84/.github/dependabot.yml#L13

Good catch, thank you @germa89. I modified the dependabot.yml file as follow:

• for the pip package ecosystem: the prefix used is now build as it concerns external dependencies.
• for the github-actions package ecosystem: the prefix used is now ci as it concerns CI configuration.

[germa89]

Do we have to change dependabot branch names too?

So far the branch names are something like dependabot/github_actions/actions-0bd1363a87 (https://github.com/ansys/pymapdl/pull/3175).

Shall we check how to change those names? or maybe skip that workflow for dependabot PRs?

[clatapie]

As the ansys/action accepts dependabot/ as a branch name, there is no need to modify it. Also, it seems that this name is not configurable.