Skip to content

RELEASING.md

Latest commit

 

History

History
36 lines (23 loc) · 2.44 KB

RELEASING.md

File metadata and controls

36 lines (23 loc) · 2.44 KB
Raw

Publish the project

Course contents · Reproducibility · Licensing

The archive contains version 1.0.0. Publishing it does not require a separate Part 4 environment. A GitHub release, tag and DOI are actions in your own accounts; no remote URL or DOI is invented in this package.

Check and commit

From the extracted project root, in a Python 3.10-or-newer environment:

python -m pip install -e ".[plots,reference,test]"
python -m unittest discover -s tests -v
python check_project.py --results

For a new repository, run git init and configure your own Git identity. Include .gitattributes before the first git add. Its single * -text rule prevents line-ending conversion, preserving the saved CSV, JSON and source snapshots on macOS, Windows and Linux. It does not prevent editing files or disable normal source diffs.

Review the staged files, then commit and tag:

git add .
git diff --cached --stat
git commit -m "Release AstroSimBench v1.0.0"
git tag -a v1.0.0 -m "AstroSimBench v1.0.0"

Add the actual GitHub remote and push your commit and tag. After publishing, clone into a separate directory and run the checks there. Keep the original saved result snapshots when adding new runs.

git clean removes untracked files; it does not distinguish bundled evidence from new experiments. Before the first staging, bundled results are also untracked. Do not use a cleanup command then. Later, preview with git clean -nd results/ and inspect the complete list before deleting anything. See the Git documentation.

Citation and optional DOI

CITATION.cff records Jingyi Zhang, the supplied ORCID, version and separate code/documentation licenses. Set date-released to the actual release date and add the real repository URL when available. GitHub can use this file for its citation menu.

For a DOI, enable the repository in Zenodo's GitHub integration before issuing the GitHub release, then check the archived metadata. Add the assigned DOI in a later metadata update. Do not add a placeholder. Zenodo gives .zenodo.json precedence over CFF, so this project uses only CFF. See Zenodo's integration guide and CFF metadata rules.