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

release: run the first dataset release, pass `CATALOG_VERSION` into the build, and write the version into CITATION.cff

Open
  • Is something wrong?
#137 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, javascript
Domain
build-system, release

Research direction

Start by reading .github/workflows/release.yml, site/build.mjs, and CITATION.cff; compare the release workflow’s build and tag steps with the version handling described in the issue. Check the workflow’s release notes extraction and the documented reverify script path in site/README.md. Done means a release has all five listed attachments, its data.json version matches the tag, CITATION.cff has the newest tag, and npm run reverify works.

Written by the indexing model from the issue text.

Description

bug documentation priority: high

Why it matters

The documented "pin a version by tag" path does not exist yet, and when it does the tag and data.json.version will be computed from two different clocks. Anyone who wants to cite, bundle or reproduce against a fixed snapshot (researchers, the MCP/CLI audience of #115, the CITATION.cff audience) has nothing to point at. #113 is closed, but the user-visible outcome is not there.

Evidence (at 69387df)

  • gh release list is empty; gh run list --workflow=release.yml has no runs. The workflow (.github/workflows/release.yml) has workflow_dispatch and a cron for the 1st of each month, so the first scheduled run is 2026-11-01.
  • site/README.md:149-156 ("Releases") tells readers to "Fetch a fixed version by tag from the Releases page" and that data.json "carries the same tag as version". The built data.json already says version: v2026.10.23, a tag that does not exist.
  • site/build.mjs:539-540 reads process.env.CATALOG_VERSION ("the tag a dataset release carries (release.yml)"), but release.yml:31, 37 builds without any env and computes tag="v$(date -u +%Y.%m.%d)" in a later step. Nothing asserts the two agree.
  • release.yml:43 awk '/^## /{n++} n==1' docs/review-ledger.md: if the newest ledger section is not the first ## heading, the notes silently contain only the two appended lines.
  • CITATION.cff has date-released but no version: and no identifiers:; the workflow never touches it.
  • Small adjacent gaps: package.json engines.node >=22 while .nvmrc and every workflow use 24; there is no npm run reverify although site/README.md:167 documents the script by path.

Suggested approach

  1. gh workflow run release.yml once now so a real release exists with the five attachments.
  2. In release.yml, compute the tag in a first step, write it to $GITHUB_ENV, pass CATALOG_VERSION to the build, and fail if jq -r .version site/dist/data.json differs. Guard the awk with [ -s release-notes.md ] || exit 1.
  3. Have the workflow write version: and date-released: into CITATION.cff and commit to main (the repo works off main).
  4. Optionally connect the repo to Zenodo so each release mints a DOI, and add it to CITATION.cff identifiers.
  5. Set engines.node to >=24; add "reverify": "node site/reverify-batch.mjs".

Done when

At least one release is visible with data.json, catalog.csv, feed.xml, reverified.xml, llms.txt; the attached data.json version equals the tag; CITATION.cff version equals the newest tag; npm run reverify works.

Dominant language
JavaScript
Stars
58
Forks
15
Avg merge
16h 53m
Merged PRs (30d)
14

Getting set up

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/Free-Game-Dev-Assets

All issues in TMHSDigital/Free-Game-Dev-Assets

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.