Skip to content

Add Wayback archival workflow + document preservation conventions#5

Merged
annefou merged 1 commit into
mainfrom
feat/wayback-and-archival-docs
Jun 13, 2026
Merged

Add Wayback archival workflow + document preservation conventions#5
annefou merged 1 commit into
mainfrom
feat/wayback-and-archival-docs

Conversation

@annefou

@annefou annefou commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

What

Second of the archival-anchor additions (follows #4, Software Heritage).

  • .github/workflows/wayback.yml — on release (and workflow_dispatch), submits the deployed Jupyter Book site + any URLs in wayback-urls.txt to the Internet Archive Wayback Machine (Save Page Now). Best-effort (continue-on-error), anonymous (no secrets; SPN2-with-keys path documented in the header), never blocks a release.
  • wayback-urls.txt — documented list for Mode-B / paperless claim sources (blogs, design notes, README pages) that Software Heritage can't archive because they're prose, not code.
  • docs/cicd-conventions.md — new Preservation section: the three release-time archival paths (Zenodo / Software Heritage / Wayback), what each anchors, and the never anchor on a conda package rule (SWH conda loader not in production → anchor source SWHID + pinned pixi + container).
  • docs/chain-decision-tree.md — new Mode-B (paperless claim) section: the DOI-only Quote field, the two clean paths (deposit→DOI, or question-rooted + cite-by-URL at CiTO), the artifact-PID ladder (SWHID > Zenodo DOI > repo > Wayback page), and any-resolvable-URI attribution.
  • CLAUDE.md Phase 4 — notes swh-save.yml + wayback.yml fire on release.

Notes

  • Triggers only on release/workflow_dispatch — never runs on an uninitialised template or routine pushes.
  • Untested — validate via Actions → Run workflow and check the resulting web.archive.org snapshots.
  • YAML validated locally.

🤖 Generated with Claude Code

- .github/workflows/wayback.yml: on release/dispatch, submit the deployed Jupyter
  Book site + any URLs in wayback-urls.txt to the Internet Archive Wayback Machine
  (Save Page Now). Best-effort, anonymous, never blocks the release.
- wayback-urls.txt: documented list for Mode-B / paperless claim sources.
- docs/cicd-conventions.md: new Preservation section (Zenodo / Software Heritage /
  Wayback) incl. the 'never anchor on a conda package' rule.
- docs/chain-decision-tree.md: new Mode-B (paperless claim) section — DOI-only
  Quote field, two clean chain paths, artifact-PID ladder, any-URI attribution.
- CLAUDE.md Phase 4: note swh-save.yml + wayback.yml fire on release.
@annefou annefou merged commit 93ab78a into main Jun 13, 2026
1 check passed
@annefou annefou deleted the feat/wayback-and-archival-docs branch June 13, 2026 09:09
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