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

Changelog automation #728

Merged
merged 5 commits into from
Feb 16, 2024
Merged

Changelog automation #728

merged 5 commits into from
Feb 16, 2024

Conversation

mikemhenry
Copy link
Contributor

@mikemhenry mikemhenry commented Feb 16, 2024

Developers certificate of origin

@mikemhenry
Copy link
Contributor Author

So I only set this up to do the changelog. It can do other things https://regro.github.io/rever-docs/index.html but I wanted to keep it simple for now, but I think we should consider using it to automate our release.

Each time someone makes a PR, they will:

  1. Make a copy of TEMPLATE.rst in the news/ folder, for example new_feature.rst
  2. Fill out the relevant change log entries

When it is time to make a release, run rever <version> for example rever 1.0.0rc0. This will consolidate all the entries into docs/CHANGELOG.rst.

For example this is what it looks like after running rever 1.0.0rc0
image

I am not sure where you want to link docs/CHANGELOG.rst on our docs page.

@mikemhenry mikemhenry marked this pull request as ready for review February 16, 2024 05:22
@mikemhenry
Copy link
Contributor Author

After we merge this in, I will update our wiki for how to do a release.

Copy link

codecov bot commented Feb 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1562674) 91.89% compared to head (5996129) 90.98%.
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #728      +/-   ##
==========================================
- Coverage   91.89%   90.98%   -0.92%     
==========================================
  Files         133      133              
  Lines        9650     9650              
==========================================
- Hits         8868     8780      -88     
- Misses        782      870      +88     
Flag Coverage Δ
fast-tests 90.98% <ø> (-0.92%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

put CHANGELOG symbol onto homepage grid of pages

replaces showcase notebook which is already included in the tutorial tab
@richardjgowers richardjgowers merged commit 2150c20 into main Feb 16, 2024
8 of 9 checks passed
@richardjgowers richardjgowers deleted the feat/add_changelog branch February 16, 2024 11:04
@richardjgowers
Copy link
Contributor

@mikemhenry looks good thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants