Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

CITATION.cff version is not checked or updated at release

Open Beginner friendly
#102 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, go
Domain
ci-cd, release

Research direction

Read the existing CHANGELOG version check in .goreleaser.yaml, .github/scripts/release-notes.sh, and the release job in .github/workflows/go.yml; also review the release checklist in CONTRIBUTING. Add a release-time check that compares the CITATION.cff version with the tag, and document the check in the checklist. Done means a release fails when the versions differ.

Written by the indexing model from the issue text.

Description

area: release bug

Why it matters

CITATION.cff (#75) is what GitHub's "Cite this repository" button and reference managers read. Its version and date-released are hard-coded, so after the next release every citation will name an outdated version.

Evidence

  • CITATION.cff has version: 0.8.0 and date-released: "2026-10-04".
  • The release pipeline (.goreleaser.yaml, .github/scripts/release-notes.sh, the release job in .github/workflows/go.yml) checks CHANGELOG.md for the version's section but never reads or updates CITATION.cff.

Suggested approach

Add a release-time check that fails the release when CITATION.cff's version does not match the tag, next to the existing CHANGELOG check. Add a line to the release checklist in CONTRIBUTING. Alternatively, have the release job rewrite both fields, but a check is simpler and keeps the file reviewed in a PR.

Done when

A release cannot be tagged while CITATION.cff names a different version.

Dominant language
Go
Stars
1
Forks
1
Avg merge
14d 9h
Merged PRs (30d)
1

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TMHSDigital/subenum

All issues in TMHSDigital/subenum

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.