Repository navigation
v1.3.1 — corrected SWHID guidance
⚠️ Superseded for artifact evaluation — use v1.4.Appendix G in this release tells authors not to archive before acceptance under double-blind review, and asks reviewers to verify the artifact by recomputing its identifier. Neither is necessary:
- a core SWHID carries no origin, author, date or commit, so archiving at submission is safe — share only the part before the first
;and restore the qualifiers at camera-ready (v1.4 §G.3);- the archive retrieves an object by its hash, so asking a reviewer to re-derive the identifier they used to fetch the artifact tests their
tarcommand, not the artifact (v1.4 §G.7).The guidance here yields correct identifiers by a clumsier route — this is a supersession, not an erratum. Everything else in this release stands.
A correction release. If you are following the artifact-evaluation guidance in v1.3, please use this version instead.
What was wrong
Appendix G told authors to compute an artifact's identifier by running swh identify --type directory on a working copy. That hashes whatever is on disk — .git/, build output, caches, editor droppings — so it cannot match the tree Software Heritage archives from version control. Author and reviewer would both have believed they had verified something. An instruction that silently yields the wrong identifier is worse than an incomplete one: it destroys the single property the identifier exists to provide.
Demonstrated on this repository, at the commit released as v1.3:
swh identify . -> swh:1:dir:3c96945d... (polluted checkout)
clean git archive export -> swh:1:dir:a53cbfce...
git rev-parse HEAD^{tree} -> a53cbfce...
the archive's own directory -> a53cbfce...
Three independent sources agree; the checkout disagrees with all of them — and yields a different wrong answer at different times.
Two further errata, both in published text: --permissions-source does not exist in swh identify (the book cited it twice; --type accepts only auto|content|directory|origin|snapshot), and Appendix A claimed swh identify . on a checkout returns a rev SWHID — it returns a dir hash of the polluted tree.
What changed
Appendix G now carries the mandate and the invariant — the identifier always names a clean tree, never a live checkout, and for git that is exactly git rev-parse <commit>^{tree} — plus the two-phase rule: clean export before archival (the only option under double-blind), the archive's Permalinks value primary after, and their coincidence as the end-to-end check. The reviewer section now states honestly what a tarball does and does not permit.
Everything version-, tool- and platform-dependent moved to a new docs/HOWTO-artifact-swhid.md, maintained in this repository and referenced by path rather than pinned — it is expected to move as tooling does. Every command in it was executed as written; anything that could not be tested is labelled untested.
Archived source
swh:1:dir:7f7632c96529ac80f91a658fe1f5b38aab189787;origin=https://github.com/rdicosmo/source-code-of-science;visit=swh:1:snp:3a6a6fb5731051810bfdee590f8afed6def8771f;anchor=swh:1:rev:1be68205
Computed with the corrected recipe — clean export, self-checked against git rev-parse HEAD^{tree} — and verified equal to the directory the archive holds.