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.

Sign up for GitHub

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

Fixes for CITATION.cff #2020

Merged
merged 3 commits into from
May 26, 2022
Merged

Fixes for CITATION.cff #2020

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d52132
Fixes for CITATION.cff
epassaro May 10, 2022
2a51f78
Add warning to the pull request body
epassaro May 18, 2022
76264d8
Minor changes
epassaro May 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions .github/workflows/post-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ jobs:
steps:
- uses: actions/checkout@v2

- name: Wait for Zenodo webhook
run: sleep 120
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hardcoded sleep seems like an issue- is there a way to link the action as a wait instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope. That's out of our control, depends on how much time requires Zenodo to make a new release on their server. 2 mins seems enough.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if this wait time is exceeded?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A pull request is opened just with changes in CHANGELOG.rst, CITATION.cff will not updated because the release was the same at that moment the job started.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document this behavior in either the automated PR message or the development documentation

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is done, the warning looks like this: #2018


- name: Setup Python
uses: actions/setup-python@v3
with:
Expand All @@ -45,7 +48,9 @@ jobs:
run: pip install git+https://github.com/citation-file-format/doi2cff

- name: Update CITATION.cff
run: doi2cff update 10.5281/zenodo.592480
run: |
rm CITATION.cff
doi2cff init 10.5281/zenodo.592480

- uses: actions/upload-artifact@v3
with:
Expand Down Expand Up @@ -82,9 +87,13 @@ jobs:
title: Post-release ${{ env.DATE }}
body: |
*\*beep\* \*bop\**

Hi, human.

These are the changes required after the latest TARDIS release.

> :warning: **Warning:**
>
> The `post_release` workflow waits for a webhook and then updates `CITATION.cff`. If the file is not modified by this pull request, please check the latest release on [Zenodo's website](https://zenodo.org/record/592480), close this pull request, and [manually run the workflow](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow).
labels: documentation,
reviewers: wkerzendorf, andrewfullard, epassaro