Skip to content

Zenodo Sandbox caveats; cffinit as an equal CITATION.cff path - #36

Open
jt14den wants to merge 1 commit into
mainfrom
content/sandbox-callout-cffinit
Open

jt14den wants to merge 1 commit into
mainfrom
content/sandbox-callout-cffinit

Conversation

@jt14den

@jt14den jt14den commented Sep 23, 2026

Copy link
Copy Markdown
Collaborator

From the 2026-09-23 UC Carpentries run.

Release episode (making-software-citable.md)

  • New callout, What to expect from Zenodo Sandbox: separate login, 10.5072 DOIs don't resolve on doi.org (they land on DataCite's test-prefix page), Zenodo says the Sandbox can be cleaned at any time, and releases are sometimes slow or missed. Includes a 4-step fallback (wait, check the toggle, publish v0.1.1, follow the instructor).
  • Instructor note: keep a prepared fork with an archived release as a fallback.
  • Replaced "works exactly like the real Zenodo".
  • The badge and CITATION.cff examples now use the Sandbox DOI shape (sandbox badge linking to the Sandbox record), with the production shape noted. This removes the conflict with the "never put a sandbox DOI in CITATION.cff" warning.

CITATION.cff episode (adding-citation-file.md)

  • Option A (GitHub's Insert example) and Option B (cffinit) are presented as equal choices. Laura taught with cffinit.
  • The cffinit steps are checked against its source code: Create, Start (Software, title), Authors, skip Identifiers, Finish, Copy to clipboard or Download, then paste into a new CITATION.cff on GitHub.
  • Exercise 2 now points to both options.

The fast lesson checker is clean for both episodes. I didn't run a sandpaper build.

Sources: Zenodo developer docs, zenodo/zenodo#1708, zenodo/zenodo#2420

….cff

- Release episode: 'What to expect from Zenodo Sandbox' callout (separate
  login, 10.5072 DOIs don't resolve on doi.org, records may be cleaned,
  slow or missed releases) with a fallback checklist and an instructor
  note on keeping a prepared repo ready
- Badge and CITATION.cff examples now show Sandbox-shaped DOIs, with the
  production shape noted, fixing the conflict with the sandbox-DOI warning
- CITATION.cff episode: Option A (GitHub template) and Option B (cffinit
  form, step by step) presented as equal choices
@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/UC-OSPO-Network/research-software-citable-discoverable/compare/md-outputs..md-outputs-PR-36

The following changes were observed in the rendered markdown documents:

 adding-citation-file.md    | 29 ++++++++++++++++++++---------
 making-software-citable.md | 46 ++++++++++++++++++++++++++++++++++++++--------
 md5sum.txt                 |  4 ++--
 3 files changed, 60 insertions(+), 19 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2026-09-23 19:55:35 +0000

@jt14den

jt14den commented Sep 23, 2026

Copy link
Copy Markdown
Collaborator Author

@U2NG tried to capture some things to say about the sandbox for that episode, check it out. and merge if it makes sense.

This branch has not been deployed

No deployments
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.

1 participant