Skip to content

Rename "native" runtime/runner to "ambient"#224

Merged
tsibley merged 6 commits into
masterfrom
trs/native→ambient
Oct 12, 2022

Hidden character warning

The head ref may contain hidden characters: "trs/native\u2192ambient"
Merged

Rename "native" runtime/runner to "ambient"#224
tsibley merged 6 commits into
masterfrom
trs/native→ambient

Conversation

@tsibley
Copy link
Copy Markdown
Contributor

@tsibley tsibley commented Oct 6, 2022

See commit messages for details.

Related issue(s)

Related to #218.

Testing

  • Local tests pass
  • Manually driving commands works ok
  • CI passes

@tsibley tsibley requested a review from a team October 6, 2022 23:57
@tsibley tsibley mentioned this pull request Oct 7, 2022
17 tasks
Copy link
Copy Markdown
Member

@victorlin victorlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Manual testing:

  • nextstrain build --native still works
  • having runner = native in ~/.nextstrain/config still works

Looks good! Just a few minor things.

Comment thread nextstrain/cli/argparse.py
Comment thread nextstrain/cli/util.py
@tsibley tsibley force-pushed the trs/native→ambient branch from c7ee3cc to b160fc5 Compare October 11, 2022 23:10
The incompatibility of --image is no longer limited to just the "native"
runner.
One piece still suitable for usage with argparse's "type" and another
suitable for internal use.  For the latter, we don't want to be
importing from nextstrain.cli.argparse or catching ArgumentTypeErrors.
…nvalid name is given

This sort of hint is super helpful to users.
…instead of handling it in a one-off way.  The initial reason for doing
something else here was so "choices" could be used, but that reason is
moot now that I've included the list of valid names in the error
messages produced by runner_module_argument().  It's good for usability
to maintain consistency across commands in handling of arguments.

This consistency also means `setup` will now accept unnormalized names
like "AWS-Batch" and future aliases.

Most changes in the diff are simple "runner" → "opts.runner" swaps due
to the type change of the latter meaning the former is no longer
necessary.
This name better reflects what it is and has been a long time coming.
"Native" was never a name I was happy with, even when I introduced it.
The more descriptive name will help us explain what it is in
documentation and also further distinguish it from the new Conda
runtime, which is also "native" in the binary executable sense.

Continue to accept --native and "native" for backwards compatibility,
however.  The --native option continues to work anywhere it used to
previously but is hidden from --help output to discourage new use.
Anywhere runner names are accepted, e.g. in config as core.runner or in
command-line arguments to `check-setup`, "native" is accepted as well.
@tsibley tsibley force-pushed the trs/native→ambient branch from b160fc5 to 6b55b97 Compare October 12, 2022 21:53
@tsibley tsibley merged commit 550f0a9 into master Oct 12, 2022
@tsibley tsibley deleted the trs/native→ambient branch October 12, 2022 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

2 participants