Introduce minimum augur version check #1070
Open
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
This is complicated by the various different ways the workflow can be run. Running with `--use-conda` means conda won't necessarily be available (and if it is it's not the correct version to check), and there may be other scenarios.
jameshadfield
commented
May 16, 2023
| logger.error(textwrap.dedent( | ||
| f"\nYour version of augur ({augur_version.__version__}) needs to be upgraded to use this workflow." + | ||
| f"\nThe minimum augur version required is {minumim_supported_augur_version}." + | ||
| "\nPlease see https://docs.nextstrain.org/en/latest/guides/manage-installation.html for help with updating your installation." + |
There was a problem hiding this comment.
We could add "If you think this version check is not applicable for how you are running this workflow, you may remove it by setting config['skip_augur_version_check'] = true" here if we are worried (like I am) about not wanting to completely disable some rare (?) invocations of the workflow.
4 tasks
|
There is an ancient (2-year-old now) PR that does something similar but only when the workflow errors. Checking preemptively seems maybe better, though. |
|
Noting that this is analagous to nextstrain/mpox@d9f6d47. |
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.
I implemented this as part of updating #1000, but there are so many ways this pipeline may be run (and which I don't have experience with) that it's not appropriate for that PR. The downside of false-positives outweighs the benefits, so any version check has to be sure we are using the augur version we think we are - probably more so than in the code's current form. It would be worth it to catch these incompatibilities early as I'm sure this'll trip up some people.
Note that this PR failed CI in a useful way :)