-
Notifications
You must be signed in to change notification settings - Fork 58
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
Fix CHANGELOG formatting issues #701
Conversation
Codecov Report
@@ Coverage Diff @@
## main #701 +/- ##
==========================================
+ Coverage 85.31% 85.34% +0.02%
==========================================
Files 41 41
Lines 4521 4530 +9
==========================================
+ Hits 3857 3866 +9
Misses 664 664
Continue to review full report at Codecov.
|
.github/workflows/testing.yml
Outdated
push: | ||
branches: | ||
- "main" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a change you want merged?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I deleted these lines to skip the test when the CHANGELOG is updated (there is a push to main). Do you think this is the best way to do that? I believe we don't usually have direct commits pushes to main, and the Docs build is not affected by skipping those tests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm thinking there might be a way to filter based on tags or the commit message/PR title, so we could run it generally, but skip commits from the changelog Action.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing the changelog. I think we need to add some info about making releases and/or updating the changelog to the contributing guidelines, but that can come in a later PR.
Ah, we do have the skip CI action, so if we can include any of the following in the changelog commits, that would work: |
That's a very nice solution. Thanks! |
I think this is ready to merge and then test with a new release candidate. @JulioAPeraza do you agree? |
Agreed. I think we need to check that the Action doesn't reformat the admonitions. I was looking for an equivalent of newline \n and horizontal tab \t to reproduce the typical format, but I couldn't get anything to work with RST. |
Darn, it looks like there's a problem in the YAML file: https://github.com/neurostuff/NiMARE/actions/runs/2490490055/workflow |
I think we would need to enclose the commit message in quotation marks? |
Closes None.
Changes proposed in this pull request: