Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ingest: Add example build-config/ci/config.yaml #71

Closed
genehack opened this issue Oct 29, 2024 · 1 comment
Closed

ingest: Add example build-config/ci/config.yaml #71

genehack opened this issue Oct 29, 2024 · 1 comment

Comments

@genehack
Copy link
Contributor

genehack commented Oct 29, 2024

Snakemake requires at least one top level key in a config file, so including a bogus key here that should not be used anywhere in the Snakemake workflow

More precisely, Snakemake requires a YAML file with a top-level map/dict/object type. It may be empty; keys are not required.

We could avoid the bogus config key above by using flow syntax for a map ({}) instead, e.g.

# TODO: If the ingest workflow ever runs too long, we should figure out a way
# to subset the ingest data. Currently, the CI just runs the default ingest workflow.
{}

The bogus config key also got propagated to measles, rabies, and oropouche, and seems likely to propagate further over time. It'd be nice to avoid, IMO.

Originally posted by @tsibley in 44f27a5

genehack referenced this issue in nextstrain/zika Oct 29, 2024
The ingest workflow current runs in <1 minute so I figured it'd be nice
to add as an additional check in the GH Action CI workflow.
If the ingest workflow ever runs for too long, we should figure out a
way to subset the ingest data.

The CI build config includes a bogus key because Snakemake requires the
config file to have at least one top level key.

Previous CI run without the bogus key ran into an error¹
```
snakemake.exceptions.WorkflowError: Config file must be given as JSON or YAML with keys at top level.
```

¹ <https://github.com/nextstrain/zika/actions/runs/9948628997/job/27483549394#step:9:17>
@joverlee521 joverlee521 changed the title Change bogus key to empty object ingest: Add example build-config/ci/config.yaml Oct 29, 2024
@joverlee521
Copy link
Contributor

Consolidated with #56

@joverlee521 joverlee521 closed this as not planned Won't fix, can't repro, duplicate, stale Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants