Repository navigation
Update documentation for v1.2.0 and document cases - #146
Merged
Merged
Conversation
Document the random suffix and optional prefix of output branch names, the rdm-check pre-commit hook in the getting started guide and the README, and pushing only the output repository. Remove the container example files and the containerization keyword left over from the container adapters.
hannahlanzrath
added this pull request to stack #147
October 5, 2026 13:57
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Add a user guide page on how a project commit, options and an environment identify a result: the options hash and which keys it ignores, reusing options, environment requirements, preparing the project package with tracks_results, and running and loading cases. Fix outdated master branch references and typos in the introduction, the logo path and the README links that broke the docs build. Closes #80
hannahlanzrath
changed the title
Closed
11 tasks done
The examples stored the token under the jugit URL but created the remotes on GitHub, and passed https://github.com/ as the API URL, which PyGithub answers with the website's 404 page. Store the token under https://github.com/ and pass https://api.github.com when creating remotes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #80.
Brings the README and user guide in line with the changes in this stack.
Output branch names: runs now get a random suffix (c9348e0) and an optional prefix from
options.branch_prefix. The format in the getting-started, Python and CLI pages and the description in the README are updated.rdm-checkhook (Add rdm-check pre-commit hook #144): mentioned in the getting-started guide and the README, pointing to the CLI page for the setup.Pushing only the output repository (Add rdm push --output-only #142):
rdm push --output-onlyin the getting-started guide,repo.output_repo.push()in the Python interface.Container leftovers (Remove container adapters and Dockerfile template #132):
examples/Dockerfileandexamples/Apptainer.defwere added together with the container adapters and are no longer referenced, so they are removed. Thecontainerizationkeyword is dropped from.zenodo.json.New page
user_guide/cases.md(Documentation Update #80): explains how a project commit,Optionsand anEnvironmentidentify a result._-prefixed keys don't count.~. The environment is recorded per run, and requirements are checked, not installed.tracks_results.Case.run_study()versus the read-onlyCase.load()(Keep Case.load() read-only and sync output results in run_study() #130), including the mismatch flags.Creating remotes on GitHub: the examples stored the token under the jugit URL but created the remotes on GitHub. They also passed
https://github.com/as the API URL; PyGithub then requests the website and fails with a 404, so these examples never worked. The token is now stored underhttps://github.com/and the remotes are created withhttps://api.github.com, in the getting-started, Python and CLI pages.Introduction:
master→main, typo fixes, and a pointer to the new page.Docs build: fixed the logo path and the README links to
CONTRIBUTING.mdandAUTHORS.md, which caused the three warnings onmain. The Sphinx build now has no warnings.Checked against the code: the version specifier and hash-exclusion rules stated on the page.