-
Notifications
You must be signed in to change notification settings - Fork 576
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
[ENH] use citation.cff to store affiliations of authors #3754
Merged
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
12c4e13
basic citation file
Remi-Gau 96fd97b
add other authors
Remi-Gau 7b3e498
add orcid
Remi-Gau 4adcd41
add links to doc - [skip ci]
Remi-Gau d599970
basic script
Remi-Gau 3d2c726
update citation cff
Remi-Gau 3ce363a
sort citation authors
Remi-Gau b27e840
add missing authors
Remi-Gau 4839d7c
fix authors
Remi-Gau cc49d6f
update AUTHORS.rst
Remi-Gau 8ef787f
add some affiliations
Remi-Gau 9e5d398
Merge remote-tracking branch 'upstream/main' into enh/citation_cff
Remi-Gau 46b0d90
fix
Remi-Gau fedc314
add workflow to automate file changes
Remi-Gau 6c0734a
add header
Remi-Gau 8f86fad
add doc
Remi-Gau f273c90
update doc
Remi-Gau c2e536e
fix
Remi-Gau 58f77db
Merge remote-tracking branch 'upstream/main' into enh/citation_cff
Remi-Gau 0ad868d
update files before doc build
Remi-Gau 708d68b
update doc
Remi-Gau fe4a835
fix name of lexer
Remi-Gau File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# github action to update AUTHORS.rst file if CITATION.cff is updated | ||
name: update authors | ||
|
||
on: | ||
push: | ||
branches: | ||
- "main" | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
update_authors: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.11" | ||
|
||
- name: install dependencies | ||
run: python -m pip install --upgrade pip ruamel.yaml | ||
|
||
- name: update AUTHORS.rst and doc/changes/names.rst | ||
run: python maint_tools/citation_cff_maint.py | ||
|
||
- name: Create Pull Request | ||
uses: peter-evans/create-pull-request@v5 | ||
with: | ||
commit-message: update AUTHORS.rst and doc/changes/names.rst | ||
base: main | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
delete-branch: true | ||
title: '[BOT] update AUTHORS.rst and doc/changes/names.rst' | ||
body: 'done via this [GitHub Action](https://github.com/${{ github.repository_owner }}/nilearn/blob/main/.github/workflows/update_authors.yml)' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: validation of citation.cff | ||
|
||
on: | ||
push: | ||
branches: ['*'] | ||
pull_request: | ||
branches: ['*'] | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
|
||
validate_cff: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Check whether the citation metadata from CITATION.cff is valid | ||
uses: citation-file-format/cffconvert-github-action@2.0.0 | ||
with: | ||
args: --validate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Since running
citation_cff_maint.py
is automated can we keep the instructions simple for 1st time contributors so all they have to do is add their names tocitation.cff
?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.
yup I was thinking about that too: will update
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.
update the contributing.rst also with an example of what to add in the citation.cff