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

Fix CHANGELOG formatting issues #701

Merged
merged 3 commits into from
Jun 13, 2022
Merged

Conversation

JulioAPeraza
Copy link
Collaborator

Closes None.

Changes proposed in this pull request:

  • Fix the admonitions that were reformatted by update-changelog Action.
  • Remove bullet points from multiline elements by having everything on a single line.
  • Reorder the release versions by switching the latest version 0.0.12rc6 with 0.0.12rc3.
  • Add links to the full changelog to the headings to match the format of the update-changelog Action.

@codecov
Copy link

codecov bot commented Jun 10, 2022

Codecov Report

Merging #701 (0e0c46e) into main (3d3d1ea) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            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              
Impacted Files Coverage Δ
nimare/dataset.py 89.96% <0.00%> (+0.23%) ⬆️
nimare/transforms.py 75.71% <0.00%> (+0.26%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3d3d1ea...0e0c46e. Read the comment docs.

Comment on lines 4 to 6
push:
branches:
- "main"
Copy link
Member

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?

Copy link
Collaborator Author

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.

Copy link
Member

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.

Copy link
Member

@tsalo tsalo left a 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.

@tsalo tsalo added the documentation Improving documentation for the project label Jun 11, 2022
@tsalo
Copy link
Member

tsalo commented Jun 12, 2022

Ah, we do have the skip CI action, so if we can include any of the following in the changelog commits, that would work: [skip ci];[ci skip];[skip github].

@JulioAPeraza
Copy link
Collaborator Author

That's a very nice solution. Thanks!

@tsalo
Copy link
Member

tsalo commented Jun 13, 2022

I think this is ready to merge and then test with a new release candidate. @JulioAPeraza do you agree?

@JulioAPeraza
Copy link
Collaborator Author

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.

@tsalo tsalo merged commit 54f5f52 into neurostuff:main Jun 13, 2022
@tsalo
Copy link
Member

tsalo commented Jun 13, 2022

Darn, it looks like there's a problem in the YAML file: https://github.com/neurostuff/NiMARE/actions/runs/2490490055/workflow

@JulioAPeraza
Copy link
Collaborator Author

I think we would need to enclose the commit message in quotation marks?

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

Successfully merging this pull request may close these issues.

2 participants