Skip to content

docs: cite the release DOI - #162

Merged
uniqueg merged 1 commit into
devfrom
docs/cite-doi
Nov 21, 2026
Merged

uniqueg merged 1 commit into
devfrom
docs/cite-doi

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Closes #161

Summary

Zenodo has archived tesk-core's releases v0.11.0 and v0.12.0 under the concept DOI 10.5281/zenodo.24082887, which always resolves to the latest version (v0.12.0 record). This PR adds it, as Pubgrade did (elixir-cloud-aai/Pubgrade#135):

  • README.md: a DOI badge, last in the badge row, and the DOI in the Citation section. The docs (docs/) don't include the README, so they need no change.
  • CITATION.cff: doi: and an identifiers: entry for the concept DOI.

Later releases need no update.

Light lane: changes only docs and citation metadata text, so no reviewer subagents.

Verification

  • cffconvert --validate -i CITATION.cff (cffconvert 2.0.0, as in CI's Lint job): "Citation metadata are valid according to schema version 1.2.0."
  • The concept DOI and both version records (v0.11.0: 10.5281/zenodo.24082888, v0.12.0: 10.5281/zenodo.24265673) were checked through the Zenodo API.
  • mkdocs build --strict not run locally: no file under docs/ or mkdocs.yml changed; CI's Docs job runs it.
  • CI: all checks passed, including CI passed and Docs (run); Sourcery approved with no threads.

Open questions

None.

🤖 Generated with Claude Code

Summary by Sourcery

Add DOI-based citation information for tesk-core releases.

New Features:

  • Add the Zenodo concept DOI to the README with a badge and citation guidance.

Enhancements:

  • Update citation metadata to include the release concept DOI and version identifiers.

Documentation:

  • Document how to cite tesk-core using its DOI and link to the latest Zenodo release.

Add the Zenodo concept DOI 10.5281/zenodo.24082887, which always
resolves to the latest version, to the README (DOI badge, last in the
badge row, and the Citation section) and to CITATION.cff (doi: and
identifiers:), as Pubgrade does.

Closes #161

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@uniqueg uniqueg self-assigned this Nov 21, 2026
@sourcery-ai

sourcery-ai Bot commented Nov 21, 2026

Copy link
Copy Markdown

Reviewer's Guide

Documentation

Add the Zenodo concept DOI to the citation metadata and README badge and citation guidance.

  • CITATION.cff L59-65
  • README.md L67-70 (+3 small edits)

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codecov

codecov Bot commented Nov 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (d640861) to head (28342f5).

Additional details and impacted files
@@            Coverage Diff            @@
##               dev      #162   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines         1799      1799           
=========================================
  Hits          1799      1799           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@uniqueg
uniqueg marked this pull request as ready for review November 21, 2026 03:55
@sourcery-ai

sourcery-ai Bot commented Nov 21, 2026

Copy link
Copy Markdown

Linked issues

Checked at commit 28342f5

#161 docs: cite the release DOI · 4 of 4 met

# Requirement Status Notes
1 Add a DOI badge as the last badge in the README badge row ✅ Met The DOI badge is last in the badge row and links to the concept DOI.
2 Add the concept DOI to the README Citation section ✅ Met The section gives the DOI and explains that it resolves to the latest version.
3 Add the concept DOI as doi: in CITATION.cff ✅ Met CITATION.cff sets doi to 10.5281/zenodo.24082887.
4 Add the concept DOI as an entry in identifiers: in CITATION.cff ✅ Met The DOI identifier entry uses the concept DOI and describes it as covering all Zenodo versions.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@uniqueg
uniqueg merged commit af37fba into dev Nov 21, 2026
59 checks passed
@uniqueg
uniqueg deleted the docs/cite-doi branch November 21, 2026 04:11
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.

docs: cite the release DOI

1 participant