-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Add a GitHub Actions workflow for automatic validation of the citation metadata file (CITATION.CFF)
#44062
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
Merged
+34
−0
Merged
Add a GitHub Actions workflow for automatic validation of the citation metadata file (CITATION.CFF)
#44062
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,33 @@ | ||
| name: cffconvert | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - 'master' | ||
| - 'release-*' | ||
| paths: | ||
| - CITATION.cff | ||
| pull_request: | ||
| branches: | ||
| - 'master' | ||
| - 'release-*' | ||
| paths: | ||
| - CITATION.cff | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| validate: | ||
| name: "validate" | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out a copy of the repository | ||
| uses: actions/checkout@v2 | ||
|
abelsiqueira marked this conversation as resolved.
Outdated
|
||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - 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 hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Currently, this workflow will not be triggered on pull requests that come from forks.
I think the behavior we want is this:
CITATION.cfffile was modified, and this is a pull request, and the base (target) branch of the pull request is eithermasterorrelease-*, then run the workflow.CITATION.cfffile was modified, and this is a push to eithermasterorrelease-*, then run the workflow.I think that the following suggestion implements the above behavior, although it would be good for someone else to double-check.