feat: adding 'documentation' type to pyproject

[germa89]

Description

I want to have a Documentation section in the release page.

I believe this is an starting point, but because of this:
https://github.com/ansys/actions/blob/d01c6d2b1098b42ea9657767171034607431bb67/doc-changelog/action.yml#L120-L125

I think there inner plumbing is still not in place.

Issue linked

N/A

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

[ansys-reviewer-bot]

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

@ansys-reviewer-bot review

[germa89]

Pinging @klmcadams for feedback.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.17%. Comparing base (d4fe3a1) to head (487b437).
Report is 63 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3189      +/-   ##
==========================================
- Coverage   86.61%   84.17%   -2.45%     
==========================================
  Files          53       53              
  Lines        9630     9630              
==========================================
- Hits         8341     8106     -235     
- Misses       1289     1524     +235     

[clatapie]

I guess this change also needs to be applied here, otherwise, I think that it will be ignored by the action.

[germa89]

I guess this change also needs to be applied here, otherwise, I think that it will be ignored by the action.

You are right. @klmcadams can you confirm?

[klmcadams]

@clatapie @germa89 that's right! I'd probably add it under the "bug" line: "documentation": "documentation". The key is the label that is in the PR and the value is the section that will be in the changelog

[germa89]

@klmcadams Instead of adding "Documentation": "documentation" key to that dict, I rather you have a look first to this PR #3183 where some related discussion is happening.

I think all conversation started here: #3183 (comment)

[germa89]

Delayed until changes are implemented in changelog action.

[germa89]

Please @klmcadams let me know when this is ready.

[germa89]

@klmcadams I guess this PR is no longer needed since:

https://github.com/ansys/actions/blame/13ad448c784451d20c407a40f456b89cc6565df8/doc-changelog/parse_pr_title.py#L221C9-L229

GitHub

Blaming actions/doc-changelog/parse_pr_title.py at 13ad448c784451d20c407a40f456b89cc6565df8 · ansys/actions

A collection of reusable workflows. Contribute to ansys/actions development by creating an account on GitHub.

[klmcadams]

@germa89 yes, sorry! @RobPasMue has a release been made to incorporate the doc-changelog changes yet?

[RobPasMue]

@germa89 yes, sorry! @RobPasMue has a release been made to incorporate the doc-changelog changes yet?

Not yet. I need to talk with @jorgepiloto first. We should do a major release probably

[RobPasMue]

Also, we should solve ansys/actions#531, at least partially first...

[RobPasMue]

I can work on that this morning before releasing.

[germa89]

Any news about this? @RobPasMue @klmcadams ? :)

[klmcadams]

@germa89 yes! If you bump doc-changelog to v7, then it should update your pyproject.toml by adding the missing tool.towncrier.type sections. If you want to use conventional commits, then add "use-conventional-commits: true" under the "with" section

[germa89]

use-conventional-commits

I'm a bit confused on what does this argument. I did checked the action and still I don't get it. I guess it needs a bit of documentation??

https://github.com/ansys/actions/blob/c9169fb523c39288fcf62425917f8b5de5d01dc0/doc-changelog/action.yml#L75

GitHub

actions/doc-changelog/action.yml at c9169fb523c39288fcf62425917f8b5de5d01dc0 · ansys/actions

A collection of reusable workflows. Contribute to ansys/actions development by creating an account on GitHub.

[germa89]

Closing because it has been implemented in the actions. Thank you a lot @klmcadams !! :)

[klmcadams]

use-conventional-commits

I'm a bit confused on what does this argument. I did checked the action and still I don't get it. I guess it needs a bit of documentation??

https://github.com/ansys/actions/blob/c9169fb523c39288fcf62425917f8b5de5d01dc0/doc-changelog/action.yml#L75

GitHub**actions/doc-changelog/action.yml at c9169fb523c39288fcf62425917f8b5de5d01dc0 · ansys/actions**A collection of reusable workflows. Contribute to ansys/actions development by creating an account on GitHub.

The use-conventional-commits input is true when you want the bot to determine what category your fragment file should be in based on the conventional commit in your PR title, rather than the labels in the PR. For example, this PR would be 3189.added.md since the conventional commit type "feat" would equate to "added" in the changelog, and the content of the file would be "adding 'documentation' type to pyproject"

[germa89]

Got it now. Thank you! :)

[klmcadams]

No problem! :)