Add a GitHub Actions workflow for automatic validation of the citation metadata file (`CITATION.CFF`) #44062

abelsiqueira · 2022-02-07T15:01:55Z

Hello!

We noticed that your CITATION.cff had a small issue and fixed it.

In addition to the fix, this Pull Request automates validation of that file using the cffconvert GitHub Action. That way, it's a little bit easier to be robust against future changes to the CITATION.cff file.

BTW it's perfectly fine if you don't feel like accepting this Pull Request for whatever reason -- we just thought it might be helpful is all.

We found your repository using a partially automated workflow; if you have any questions about that, feel free to create an issue over at https://github.com/cffbots/filtering/issues/

On behalf of the cffbots team,
@abelsiqueira / @fdiblen / @jspaaks

DilumAluthge

The persist-credentials: false option should be passed to actions/checkout@v2
The GITHUB_TOKEN in this workflow should not have any write permissions. This can be accomplished by setting the appropriate top-level permissions key.

fredrikekre · 2022-02-07T21:22:16Z

Is it really necessary to have a workflow for a file which is more or less static?

DilumAluthge · 2022-02-07T21:43:07Z

Agreed; I would prefer that we not add a workflow solely for this file.

vtjnash · 2022-02-07T21:54:08Z

The way the workflow is written, it only gets triggered precisely when it is needed, so I think that addition is good

fredrikekre · 2022-02-08T08:40:31Z

Still, it will use some resources for every push to check if this file is in the diff, no?

abelsiqueira · 2022-02-08T08:41:22Z

Hi @DilumAluthge, I have updated the workflow following your comment. Let me know if this is correct.

DilumAluthge

You can further simplify the permissions section. If you specify the permissions you need (e.g. contents: read), and omit all other permissions, the omitted permissions should automatically be set to none, per the GitHub docs here: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions

abelsiqueira · 2022-02-08T09:42:57Z

Thanks for the link, @DilumAluthge. I left only contents: read now.

DilumAluthge · 2022-02-10T01:17:55Z

.github/workflows/cffconvert.yml

+on:
+  push:
+    paths:
+      - CITATION.cff


Currently, this workflow will not be triggered on pull requests that come from forks.

I think the behavior we want is this:

If the CITATION.cff file was modified, and this is a pull request, and the base (target) branch of the pull request is either master or release-*, then run the workflow.

If the CITATION.cff file was modified, and this is a push to either master or release-*, then run the workflow.

Else, do not run the workflow.

I think that the following suggestion implements the above behavior, although it would be good for someone else to double-check.

Suggested change

on:

push:

paths:

- CITATION.cff

on:

push:

branches:

- 'master'

- 'release-*'

paths:

- CITATION.cff

pull_request:

branches:

- 'master'

- 'release-*'

paths:

- CITATION.cff

abelsiqueira · 2022-02-10T08:44:21Z

Hi @DilumAluthge, I have updated the workflow and I made some tests:

https://github.com/cffbots/julia/actions
I have pushed to master
I have created a branch release-no-change-to-cff with no changes to CITATION.cff and it did not trigger the action
I have created a branch release-change-to-cff with changes to CITATION.cff and it did trigger the action
I have forked cffbots/julia to abelsiqueira/julia and created 4 PRs:

Let me know what you think.

DilumAluthge · 2022-02-16T07:20:27Z

@abelsiqueira Would you mind making a small separate PR that just has the fix to the CITATION.cff file? That change seems pretty uncontroversial and can be merged quickly.

abelsiqueira · 2022-02-18T08:22:41Z

Hi @DilumAluthge, I have created #44236 with just the fix. After that PR is merged I will rebase this one.

DilumAluthge · 2022-02-19T09:05:54Z

Now that #44236 has been merged, can you rebase and squash this PR?

DilumAluthge · 2022-02-19T09:06:57Z

The question for triage is: should we add the GitHub Actions workflow file for validating this file?

DilumAluthge

From a technical point of view, this looks good. Let's see what triage thinks about the idea.

The requested changes have been made.

abelsiqueira · 2022-02-21T08:09:35Z

I have rebased and squashed the commits.

vtjnash · 2022-02-22T16:56:55Z

Can you include a small no-op change to CITATION.cff in this PR, so that we can see this trigger and confirm it is working?

abelsiqueira · 2022-02-24T08:04:10Z

Can you include a small no-op change to CITATION.cff in this PR, so that we can see this trigger and confirm it is working?

I made a new no-op commit, but I don't expect it to run because the action is not part of the master branch yet. (Edit: https://github.com/JuliaLang/julia/actions/runs/1891858073, does not run because it is not part of the repo yet).

Alternatively, look at this earlier comment: #44062 (comment) specifically the cffbots#2 and cffbots#4 PRs.

JeffBezanson · 2022-03-17T19:08:56Z

From triage: this is cool, but does not really seem warranted for an almost-never-changed file with a single citation in it. But I guess we might as well do it, no real cost?

vtjnash · 2022-06-11T03:49:34Z

I enabled GitHub-provided and citation-file-format/[email protected] actions. Can you push a rebase of this?

CITATION.cff

abelsiqueira · 2022-06-13T07:29:07Z

I have rebased it.

fingolfin

This looks good to me. I see no downsides: the action is only run when really needed. And yeah the file won't be changed often -- but rare events in my experience will be messed up precisely because they are rare and people forget what to watch out for. So I'd be for merging this.

.github/workflows/cffconvert.yml

Co-authored-by: Max Horn <[email protected]>

IanButterworth · 2024-03-03T01:23:05Z

This branch is quite out of date, so getting CI green isn't worthwhile, but I'm going to merge this without a rebase because:

maintainer edits aren't enabled, so updating isn't trivial, and saves asking the OP to do so
CITATION.cff is not mentioned in the repo before this, so I can't see how it would fail anything

@abelsiqueira

…n metadata file (`CITATION.CFF`) (JuliaLang#44062) Hello! We noticed that your `CITATION.cff` had a small issue and fixed it. In addition to the fix, this Pull Request automates validation of that file using the [cffconvert GitHub Action](https://github.com/marketplace/actions/cffconvert). That way, it's a little bit easier to be robust against future changes to the `CITATION.cff` file. BTW it's perfectly fine if you don't feel like accepting this Pull Request for whatever reason -- we just thought it might be helpful is all. We found your repository using a partially automated workflow; if you have any questions about that, feel free to create an issue over at https://github.com/cffbots/filtering/issues/ On behalf of the cffbots team, @abelsiqueira / @fdiblen / @jspaaks --------- Co-authored-by: Max Horn <[email protected]>

@abelsiqueira

…n metadata file (`CITATION.CFF`) (JuliaLang#44062) Hello! We noticed that your `CITATION.cff` had a small issue and fixed it. In addition to the fix, this Pull Request automates validation of that file using the [cffconvert GitHub Action](https://github.com/marketplace/actions/cffconvert). That way, it's a little bit easier to be robust against future changes to the `CITATION.cff` file. BTW it's perfectly fine if you don't feel like accepting this Pull Request for whatever reason -- we just thought it might be helpful is all. We found your repository using a partially automated workflow; if you have any questions about that, feel free to create an issue over at https://github.com/cffbots/filtering/issues/ On behalf of the cffbots team, @abelsiqueira / @fdiblen / @jspaaks --------- Co-authored-by: Max Horn <[email protected]>

abelsiqueira requested a review from a team as a code owner February 7, 2022 15:01

abelsiqueira mentioned this pull request Feb 7, 2022

Cherrypicked GitHub repositories cffbots/filtering#50

Open

13 tasks

DilumAluthge requested changes Feb 7, 2022

View reviewed changes

DilumAluthge requested changes Feb 8, 2022

View reviewed changes

abelsiqueira force-pushed the cffbots-cffconvert branch from b2d39a9 to abd7f50 Compare February 8, 2022 09:42

jspaaks mentioned this pull request Feb 8, 2022

Look into adding permissions to the example workflow citation-file-format/cffconvert-github-action#67

Open

DilumAluthge previously requested changes Feb 10, 2022

View reviewed changes

abelsiqueira mentioned this pull request Feb 11, 2022

Add preferred-citation key to CITATION.cff after JOSS paper is released JuliaSmoothOptimizers/DCISolver.jl#91

Closed

abelsiqueira mentioned this pull request Feb 18, 2022

Fix CITATION.cff #44236

Merged

DilumAluthge added the triage This should be discussed on a triage call label Feb 19, 2022

DilumAluthge requested a review from staticfloat February 19, 2022 09:11

DilumAluthge changed the title ~~Fix CITATION.cff and add automatic validation of your citation metadata~~ Add a GitHub Actions workflow file for automatic validation of the citation metadata file (CITATION.CFF) Feb 20, 2022

DilumAluthge changed the title ~~Add a GitHub Actions workflow file for automatic validation of the citation metadata file (CITATION.CFF)~~ Add a GitHub Actions workflow for automatic validation of the citation metadata file (CITATION.CFF) Feb 20, 2022

DilumAluthge reviewed Feb 20, 2022

View reviewed changes

abelsiqueira force-pushed the cffbots-cffconvert branch from 9ed8ab6 to 3ea7c7f Compare February 21, 2022 08:09

DilumAluthge removed the triage This should be discussed on a triage call label Mar 17, 2022

vtjnash reviewed Jun 11, 2022

View reviewed changes

CITATION.cff Outdated Show resolved Hide resolved

abelsiqueira added 3 commits June 13, 2022 09:16

Add cffconvert.yml to validate CITATION.cff

9cb3875

No-op change to CITATION.cff

5e59d14

Add link to the CFF description

75cb753

abelsiqueira force-pushed the cffbots-cffconvert branch from 5c0540e to 75cb753 Compare June 13, 2022 07:25

fingolfin approved these changes Feb 27, 2024

View reviewed changes

fingolfin reviewed Feb 27, 2024

View reviewed changes

.github/workflows/cffconvert.yml Outdated Show resolved Hide resolved

Update .github/workflows/cffconvert.yml

0f523c1

Co-authored-by: Max Horn <[email protected]>

fingolfin added the merge me PR is reviewed. Merge when all tests are passing label Feb 28, 2024

IanButterworth merged commit e7734ea into JuliaLang:master Mar 3, 2024
6 of 9 checks passed

IanButterworth removed the merge me PR is reviewed. Merge when all tests are passing label Mar 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a GitHub Actions workflow for automatic validation of the citation metadata file (`CITATION.CFF`) #44062

Add a GitHub Actions workflow for automatic validation of the citation metadata file (`CITATION.CFF`) #44062

abelsiqueira commented Feb 7, 2022

DilumAluthge left a comment

fredrikekre commented Feb 7, 2022

DilumAluthge commented Feb 7, 2022 •

edited

Loading

vtjnash commented Feb 7, 2022

fredrikekre commented Feb 8, 2022

abelsiqueira commented Feb 8, 2022

DilumAluthge left a comment

abelsiqueira commented Feb 8, 2022

DilumAluthge Feb 10, 2022 •

edited

Loading

abelsiqueira commented Feb 10, 2022

DilumAluthge commented Feb 16, 2022

abelsiqueira commented Feb 18, 2022

DilumAluthge commented Feb 19, 2022

DilumAluthge commented Feb 19, 2022

DilumAluthge left a comment

abelsiqueira commented Feb 21, 2022

vtjnash commented Feb 22, 2022

abelsiqueira commented Feb 24, 2022 •

edited

Loading

JeffBezanson commented Mar 17, 2022

vtjnash commented Jun 11, 2022

abelsiqueira commented Jun 13, 2022

fingolfin left a comment

IanButterworth commented Mar 3, 2024 •

edited

Loading

-on:
-  push:
-    paths:
-      - CITATION.cff
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-*'
+    paths:
+      - CITATION.cff
+  pull_request:
+    branches:
+      - 'master'
+      - 'release-*'
+    paths:
+      - CITATION.cff

Add a GitHub Actions workflow for automatic validation of the citation metadata file (CITATION.CFF) #44062

Add a GitHub Actions workflow for automatic validation of the citation metadata file (CITATION.CFF) #44062

Conversation

abelsiqueira commented Feb 7, 2022

DilumAluthge left a comment

Choose a reason for hiding this comment

fredrikekre commented Feb 7, 2022

DilumAluthge commented Feb 7, 2022 • edited Loading

vtjnash commented Feb 7, 2022

fredrikekre commented Feb 8, 2022

abelsiqueira commented Feb 8, 2022

DilumAluthge left a comment

Choose a reason for hiding this comment

abelsiqueira commented Feb 8, 2022

DilumAluthge Feb 10, 2022 • edited Loading

Choose a reason for hiding this comment

abelsiqueira commented Feb 10, 2022

DilumAluthge commented Feb 16, 2022

abelsiqueira commented Feb 18, 2022

DilumAluthge commented Feb 19, 2022

DilumAluthge commented Feb 19, 2022

DilumAluthge left a comment

Choose a reason for hiding this comment

abelsiqueira commented Feb 21, 2022

vtjnash commented Feb 22, 2022

abelsiqueira commented Feb 24, 2022 • edited Loading

JeffBezanson commented Mar 17, 2022

vtjnash commented Jun 11, 2022

abelsiqueira commented Jun 13, 2022

fingolfin left a comment

Choose a reason for hiding this comment

IanButterworth commented Mar 3, 2024 • edited Loading

Add a GitHub Actions workflow for automatic validation of the citation metadata file (`CITATION.CFF`) #44062

Add a GitHub Actions workflow for automatic validation of the citation metadata file (`CITATION.CFF`) #44062

DilumAluthge commented Feb 7, 2022 •

edited

Loading

DilumAluthge Feb 10, 2022 •

edited

Loading

abelsiqueira commented Feb 24, 2022 •

edited

Loading

IanButterworth commented Mar 3, 2024 •

edited

Loading