Skip to content
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

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

Open
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

clatapie
Copy link
Contributor

Implementing release note in documentation, using ansys/actions/changelogs and ansys/pyansys-geometry#1138.

@clatapie clatapie requested a review from a team as a code owner April 22, 2024 12:24
@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@github-actions github-actions bot added Documentation Documentation related (improving, adding, etc) CI/CD Related with CICD, Github Actions, etc Maintenance General maintenance of the repo (libraries, cicd, etc) Dependencies labels Apr 22, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.17%. Comparing base (de18185) to head (0e51264).

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     

@clatapie clatapie marked this pull request as draft April 22, 2024 15:44
.github/release.yml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@germa89
Copy link
Collaborator

germa89 commented May 17, 2024

Is this still a draft? @clatapie

@clatapie
Copy link
Contributor Author

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
Copy link
Contributor Author

I will resume it next week

@clatapie
Copy link
Contributor Author

clatapie commented Jun 4, 2024

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.

@clatapie clatapie marked this pull request as ready for review June 4, 2024 10:04
@germa89
Copy link
Collaborator

germa89 commented Jun 11, 2024

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should add the documentation the new branch and commit names. Also mentioned the update changelog feature. Especially, if the developer needs to take something into account. Like write a meaningful PR name or similar.

Otherwise LGTM. Thank you for this @clatapie

pyproject.toml Outdated Show resolved Hide resolved
clatapie and others added 2 commits June 11, 2024 17:27
Co-authored-by: German <28149841+germa89@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Related with CICD, Github Actions, etc Dependencies Documentation Documentation related (improving, adding, etc) Maintenance General maintenance of the repo (libraries, cicd, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants