feat: adding 'documentation' type to pyproject

germa89 commented 1 week ago

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

[x] 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.
[x] 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.
[x] I have assigned this PR to myself.
[ ] I have marked this PR as draft if it is not ready to be reviewed yet.
[x] I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

ansys-reviewer-bot[bot] commented 1 week ago

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

@ansys-reviewer-bot review

germa89 commented 1 week ago

Pinging @klmcadams for feedback.

codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 84.21%. Comparing base (7c1eb1e) to head (20a29b5). Report is 17 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #3189 +/- ## ========================================== - Coverage 86.63% 84.21% -2.43% ========================================== Files 52 53 +1 Lines 9550 9625 +75 ========================================== - Hits 8274 8106 -168 - Misses 1276 1519 +243 ```

clatapie commented 1 week ago

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

germa89 commented 1 week ago

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 commented 1 week ago

@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 commented 1 week ago

@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: https://github.com/ansys/pymapdl/pull/3183#issuecomment-2178043708

germa89 commented 1 week ago

Delayed until changes are implemented in changelog action.

ansys / pymapdl