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

Add changelog to docs #603

Closed
tsalo opened this issue Nov 8, 2021 · 13 comments · Fixed by #635, #684 or #688
Closed

Add changelog to docs #603

tsalo opened this issue Nov 8, 2021 · 13 comments · Fixed by #635, #684 or #688
Labels
documentation Improving documentation for the project enhancement New feature or request

Comments

@tsalo
Copy link
Member

tsalo commented Nov 8, 2021

Summary

Currently, the only changelog NiMARE has is the release notes. While those notes are useful and comprehensive, most users will not know to check them. I would like to see if we can come up with a way to generate the changelog automatically, whether after each release or after each PR.

Next steps

  1. Look into GitHub Actions for changelog generation.
  2. Add changelog file to docs folder.
  3. Add changelog file to index.rst.
@tsalo
Copy link
Member Author

tsalo commented May 31, 2022

@JulioAPeraza It looks like the new action wasn't triggered by the 0.0.12rc3 release.

@tsalo tsalo reopened this May 31, 2022
@JulioAPeraza
Copy link
Collaborator

It looks like 0.0.12rc3 was a prereleased, so we will need to add prereleased to the activity type.

@JulioAPeraza
Copy link
Collaborator

It should look like this:

name: "Update Changelog"

on:
  release:
    types: [released, prereleased]

@tsalo
Copy link
Member Author

tsalo commented May 31, 2022

Ohhh.... thanks! Do you want to open a PR with the fix?

@JulioAPeraza
Copy link
Collaborator

Sure!

@tsalo
Copy link
Member Author

tsalo commented Jun 1, 2022

@JulioAPeraza
Copy link
Collaborator

I think it is an issue with the tag name of the release. I will open a PR with the fix.

@tsalo
Copy link
Member Author

tsalo commented Jun 1, 2022

@JulioAPeraza
Copy link
Collaborator

Is the main branch protected against automatic commits by a GitHub Action?

@tsalo
Copy link
Member Author

tsalo commented Jun 1, 2022

The status checks have to pass before PRs can be merged into main. I don't know if there's a way to treat GitHub Actions as special cases.

@tsalo tsalo reopened this Jun 1, 2022
@JulioAPeraza
Copy link
Collaborator

@JulioAPeraza
Copy link
Collaborator

I think using a Personal Access Token (PAT) may fix this issue, as pointed out in the git-auto-commit-action repo. This has to be created and stored by you as the admin of the repo, right? After that, we can add:

- uses: actions/checkout@v2
  with:
    token: ${{ secrets.PAT }}

@tsalo
Copy link
Member Author

tsalo commented Jun 14, 2022

Everything's looking good now (as of 0.0.12rc7), so I'm going to close this.

@tsalo tsalo closed this as completed Jun 14, 2022
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 enhancement New feature or request
Projects
None yet
2 participants