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

docs: adding previous changes in changelog.d repository #3182

Merged
merged 6 commits into from
Jun 18, 2024

Conversation

clatapie
Copy link
Contributor

Description

As title says, adding previous changes in the changelog.d repository for future patch release.

Issue linked

Not applicable.

Checklist

@clatapie clatapie self-assigned this Jun 18, 2024
@clatapie clatapie requested a review from a team as a code owner June 18, 2024 14:22
@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

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.

Assuming this is all automatically generated.. then, it all looks good to me :)

I guess the changelog webpage will get updated automatically too?

@clatapie
Copy link
Contributor Author

I added all those files manually as commits happened prior to #3019

The Release note is built from the changelog.d directory so it should work fine. I will make a test locally before merging this PR.

Copy link

codecov bot commented Jun 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.47%. Comparing base (7c1eb1e) to head (3179f44).
Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3182      +/-   ##
==========================================
- Coverage   86.63%   84.47%   -2.17%     
==========================================
  Files          52       52              
  Lines        9550     9596      +46     
==========================================
- Hits         8274     8106     -168     
- Misses       1276     1490     +214     

@clatapie
Copy link
Contributor Author

I made some changes in the changelog fragment names as I didn't correctly named them. With no changes, release notes would have rendered as follow:

image

After having applied the changes, it will render as follow:

image

@germa89
Copy link
Collaborator

germa89 commented Jun 18, 2024

I made some changes in the changelog fragment names as I didn't correctly named them. With no changes, release notes would have rendered as follow:

image

After having applied the changes, it will render as follow:

image

Is the miscelaneous label ignored on the release changelog?

@clatapie
Copy link
Contributor Author

clatapie commented Jun 18, 2024

Also, to align with the changelog action, I will modify the repository labels:

  • Maintenance will become maintenance
  • Enhancement will become enhancement
  • Dependencies will become dependencies
  • BUG will become bug
  • etc

Pinging @klmcadams for visibility.

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance and removed Documentation labels Jun 18, 2024
@clatapie
Copy link
Contributor Author

Is the miscelaneous label ignored on the release changelog?

No, it appears right after the Dependencies section:

image

@clatapie clatapie requested a review from germa89 June 18, 2024 15:21
@clatapie clatapie enabled auto-merge (squash) June 18, 2024 16:03
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.

LGTM!!

@clatapie clatapie merged commit e3f3a09 into main Jun 18, 2024
40 checks passed
@clatapie clatapie deleted the docs/adding_previous_changes_in_changelog branch June 18, 2024 16:06
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants