Skip to content

Conversation

c-martinez
Copy link
Member

@c-martinez c-martinez commented May 5, 2025

Changes in this PR

Adds GitHub action for publishing Guide as PDF in Zenodo using Zenodraft workflow.
Related to #270

One thing I am not sure is how to configure the action so that it can be manually tested on Zenodo Sandbox, and publishes to Zenodo on releases. The action would require two separate concept DOIs, but it looks like only one can be given. Any suggestions?

Checklist

Most check items are not relevant for this PR since it does not modify the content of the guide, but the publishing infrastructure.

SIGNIFICANT changes / additions, e.g. new chapters

  • I checked whether the contribution fits in The Turing Way before considering contributing to this Guide.
  • I discussed my contribution in an issue and took into account feedback.

ALL contributions

  • I previewed my changes locally using e.g. python3 -m http.server 4000 and confirmed they work correctly.
  • I checked for broken links, e.g. using the link checker GitHub Action workflow, or locally by using docker run --init -it -v `pwd`:/docs lycheeverse/lychee /docs --config=docs/lychee.toml, at least for the files I changed.
  • My name was added to the CITATION.cff file.

@c-martinez c-martinez marked this pull request as draft May 5, 2025 19:45
Copy link

netlify bot commented May 5, 2025

Deploy Preview for nlesc-guide-testing ready!

Name Link
🔨 Latest commit 3e6ee60
🔍 Latest deploy log https://app.netlify.com/sites/nlesc-guide-testing/deploys/68191557af076100086f9021
😎 Deploy Preview https://deploy-preview-440--nlesc-guide-testing.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@c-martinez c-martinez requested a review from egpbos May 5, 2025 19:45
Copy link

netlify bot commented May 5, 2025

Deploy Preview for nlesc-guide-testing ready!

Name Link
🔨 Latest commit 16017d1
🔍 Latest deploy log https://app.netlify.com/projects/nlesc-guide-testing/deploys/685a762e1e942e0008c382eb
😎 Deploy Preview https://deploy-preview-440--nlesc-guide-testing.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@bouweandela
Copy link
Member

I believe Zenodo is able to read CITATION.cff files, so adding the same information in a .zenodo.json file may not be necessary.

One thing I am not sure is how to configure the action so that it can be manually tested on Zenodo Sandbox, and publishes to Zenodo on releases. The action would require two separate concept DOIs, but it looks like only one can be given. Any suggestions?

would adding two copies of the action file work? With the only difference the DOI?

@egpbos
Copy link
Member

egpbos commented Jun 11, 2025

We discussed follow-up edits: copy the last step and trigger that one and the draft one before conditionally: edit the last one for tagged releases (published) and keep the other one for drafts/tests, triggering manually with workflow_dispatch.

@egpbos egpbos self-assigned this Jun 24, 2025
@egpbos
Copy link
Member

egpbos commented Jun 24, 2025

Just FYI: the published action actually also triggers for pre-releases, which might feel a bit counterintuitive (it does to me). The reason we must use it instead of the released action (which is triggered when the actual release is made final) is that zenodraft only supports the published and the workflow_dispatch actions.

@egpbos
Copy link
Member

egpbos commented Jun 24, 2025

Note: the branch was outdated, so did a rebase on main. If you want to continue working on the latest branch on your laptop, do a git pull --rebase.

@egpbos egpbos marked this pull request as ready for review June 24, 2025 09:45
@egpbos
Copy link
Member

egpbos commented Jun 24, 2025

We cannot test this from within the PR, so I'm going to merge this now.

Copy link
Member

@egpbos egpbos left a comment

Choose a reason for hiding this comment

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

Abusing my power to avoid our branch protection rules, muahaha!

@egpbos egpbos merged commit 09b25a2 into main Jun 24, 2025
7 checks passed
@egpbos egpbos deleted the use-zenodraft branch June 24, 2025 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants