Passing variables in to spacy project run

[kinghuang]

Is there a way to pass in a var value when invoking a command or workflow with spacy project run? Our spaCy 3 projects have a version var that's passed to spacy package. In CI/CD jobs, I'd like to pass in a dynamically generated value that overrides the value in the project.yml file. Something like the following.

spacy project run package --var version=0.0.0

And related to this, is there a way to use environment variables? For example, in CI/CD jobs, I want to publish packaged modules to a PyPi registry using variables provided in the CI/CD environment. Here's an example of a command using environment variables to construct the PyPi repository URL.

twine upload --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi …

[kinghuang]

Ah, looking at the code, it turns out it's possible to do config overrides. The following works for me.

spacy project run package . --vars.version=0.0.0

[kinghuang]

I spoke too soon. Passing a number like 0 or 0.0 works, but a version string like 0.0.0 results in a TypeError.

root@738ace767785:/project/lib# spacy project run package . --vars.version=0.0.0
Traceback (most recent call last):
  File "/usr/local/bin/spacy", line 8, in <module>
    sys.exit(app())
  File "/usr/local/lib/python3.8/site-packages/typer/main.py", line 214, in __call__
    return get_command(self)(*args, **kwargs)
  File "/usr/local/lib/python3.8/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.8/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.8/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.8/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.8/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.8/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.8/site-packages/typer/main.py", line 497, in wrapper
    return callback(**use_params)  # type: ignore
  File "/usr/local/lib/python3.8/site-packages/spacy/cli/project/run.py", line 41, in project_run_cli
    project_run(project_dir, subcommand, overrides=overrides, force=force, dry=dry)
  File "/usr/local/lib/python3.8/site-packages/spacy/cli/project/run.py", line 69, in project_run
    commands = {cmd["name"]: cmd for cmd in config.get("commands", [])}
  File "/usr/local/lib/python3.8/site-packages/spacy/cli/project/run.py", line 69, in <dictcomp>
    commands = {cmd["name"]: cmd for cmd in config.get("commands", [])}
TypeError: string indices must be integers

[kinghuang]

Filed as issue #7736.

[kinghuang]

Environment variables are possible using env substitutions.

env:
  who: USER

commands:
  - name: hello
    script:
      - echo "Hello, ${env.who}!"