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

Automate release notes #568

Merged
merged 36 commits into from
Apr 30, 2024
Merged

Automate release notes #568

merged 36 commits into from
Apr 30, 2024

Conversation

amandarichardsonn
Copy link
Contributor

@amandarichardsonn amandarichardsonn commented Apr 25, 2024

This PR adds a release.yml file to the root of the .github folder. Within the file we configure the release notes generated through PR tags. This PR also converts the changelog format from rst to md to match release notes format.

To test this PR:

  1. navigate to the SmartSim github page
  2. Select Releases on the right column
  3. Select Draft New Release
  4. Create a tag and set the branch to release-notes
  5. Select Generate Release Notes

Copy link

codecov bot commented Apr 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.43%. Comparing base (7db8490) to head (5defe4e).

❗ Current head 5defe4e differs from pull request most recent head 3641e83. Consider uploading reports for the commit 3641e83 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #568      +/-   ##
===========================================
- Coverage    77.77%   69.43%   -8.34%     
===========================================
  Files           66       66              
  Lines         4571     4571              
===========================================
- Hits          3555     3174     -381     
- Misses        1016     1397     +381     

see 26 files with indirect coverage changes

@amandarichardsonn amandarichardsonn added the area: CI/CD Issues related to continuous integration and deployment label Apr 25, 2024
@amandarichardsonn amandarichardsonn changed the title Hold title Automate release notes Apr 25, 2024
@amandarichardsonn amandarichardsonn marked this pull request as draft April 26, 2024 05:23
@amandarichardsonn amandarichardsonn marked this pull request as ready for review April 26, 2024 23:26
@AlyssaCote AlyssaCote self-requested a review April 29, 2024 17:59
@AlyssaCote AlyssaCote removed their assignment Apr 29, 2024
Copy link
Contributor

@AlyssaCote AlyssaCote left a comment

Choose a reason for hiding this comment

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

This looks great! Just a couple little fixes and this will be good to go!

doc/changelog.md Outdated Show resolved Hide resolved
doc/changelog.md Show resolved Hide resolved
doc/changelog.md Outdated Show resolved Hide resolved
Copy link
Contributor

@AlyssaCote AlyssaCote left a comment

Choose a reason for hiding this comment

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

I found a couple more things!

doc/changelog.md Outdated Show resolved Hide resolved
doc/changelog.md Outdated Show resolved Hide resolved
doc/changelog.md Outdated Show resolved Hide resolved
@AlyssaCote AlyssaCote self-requested a review April 30, 2024 18:04
Copy link
Contributor

@AlyssaCote AlyssaCote left a comment

Choose a reason for hiding this comment

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

LGTM!!! Appreciate all the hard work!

@amandarichardsonn amandarichardsonn merged commit 674b421 into develop Apr 30, 2024
34 checks passed
@amandarichardsonn amandarichardsonn deleted the release-notes branch April 30, 2024 22:14
ankona pushed a commit to ankona/SmartSim that referenced this pull request May 6, 2024
This PR adds a `release.yml` file to the root of the `.github` folder.
Within the file we configure the release notes generated through PR
tags. This PR also converts the changelog format from rst to md to match
release notes format.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: CI/CD Issues related to continuous integration and deployment ignore-for-release non-user-facing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants