Skip to content

Add CITATION.cff and set the v0.2.2 release date - #12

Merged
Yehuda-Bergstein merged 4 commits into
mainfrom
release/v0.2.2-citation
Oct 22, 2026
Merged

Yehuda-Bergstein merged 4 commits into
mainfrom
release/v0.2.2-citation

Conversation

@Yehuda-Bergstein

@Yehuda-Bergstein Yehuda-Bergstein commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Two small changes before the v0.2.2 tag.

CITATION.cff (new). Zenodo now archives each GitHub release of this repository and gives it a DOI. It takes the record's authors, their ORCID iDs, the license and the title from CITATION.cff at the tagged commit; without the file it would list only the GitHub contributors. The file names the five authors of the ResXR paper in byline order, each with an ORCID iD and Tel Aviv University, plus the Apache-2.0 license, the repository, docs.resxr.org and version 0.2.2. GitHub also uses it for the "Cite this repository" box. cffconvert --validate passes (schema 1.2.0).

CHANGELOG date. The 0.2.2 heading said 2026-10-04. It now gives 2026-10-22, the planned release date. Nothing else in the CHANGELOG changes.

Zenodo's GitHub integration, switched on for this repository on 22 Oct 2026, archives each GitHub release with a DOI and reads the record's creators, license and title from CITATION.cff at the tagged commit. Without the file it lists the GitHub contributors, here one person with no ORCID. The file names the five authors of the ResXR paper in byline order, each with an ORCID iD and Tel Aviv University, the Apache-2.0 license, the repository, docs.resxr.org and version 0.2.2; GitHub also shows it as "Cite this repository". cffconvert 2.0.0 validates it against CFF schema 1.2.0.
The 0.2.2 heading carried 2026-10-04. The v0.2.2 tag and GitHub release are planned for 22 Oct 2026, so the heading now gives that date. The compare links at the end of the file are unchanged.
Tag v0.2.1 had no entry, although the [0.2.2] link compares from it. The entry lists what git diff v0.2.0 v0.2.1 shows (the README commit 0b0ffc1 and the release commit 92d4c0f): the HTML report goes to report.output_dir when it is set, python -m resxr exits with the CLI's exit code, the shipped configuration drops the example column groups, which no check reads, and the README becomes a front page pointing to docs.resxr.org. The date is the GitHub release's, 2026-06-19; the tagged commit is from 2026-06-18.
The [0.2.0] link compared v0.1.1...v0.2.0, and GitHub has nothing to show there: v0.2.0's history starts from a different root commit than v0.1.x's, so the compare answers "No common ancestor". The link now points to the v0.2.0 release page, as [0.1.0] does; the page returns 200.
@Yehuda-Bergstein
Yehuda-Bergstein merged commit 2fa9aee into main Oct 22, 2026
6 checks passed
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