Allow custom snakebids version in app template #376
Merged
Conversation
This file contains 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
Adds flag --snakebids-version to the snakebids create cli that takes either a version specifier or @url
The dry run tests now specify the development repository as the snakebids version to be installed, rather than pulling from pip
github-actions
bot
requested review from
akhanf,
Bradley-Karat,
kaitj,
mcespedes99 and
myousif9
pvandyken
added
the
maintenance
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #376 +/- ##
==========================================
+ Coverage 91.61% 92.02% +0.40%
==========================================
Files 39 40 +1
Lines 1730 1767 +37
==========================================
+ Hits 1585 1626 +41
+ Misses 145 141 -4 ☔ View full report in Codecov by Sentry. |
When snakebids version is directly specified as a path, we need this configured for hatch for the install to work
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.
Adds flag
--snakebids-versionto thesnakebids createcli. It can be set to either a version specifier (e.g.>=a.b,==x.y.z) or a url (e.g.@ scheme://domain-or-path/....). Paths and git repositories are identified and properly formatted for a poetrypyproject.toml. It does not handle markers (following a;) or extras (in between[...]). Some minimal validation in the CLI command will help catch these.This is primarily intended for testing: with this improvement we can specify the path the snakebids repo in our template dry run tests, allowing us to test the current repository with all installation methods. Previously it was downloading snakebids from pip, but this causes errors in e.g. #362, where the template itself is updated and no longer compatible with the pypi installation.
Nevertheless, the cli command is documented and tested and suitable for public use within its defined scope.
(Note: technically this is an enhancement, but I'm labeling maintenance since the primary focus here is internal)