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: Move Nextclade configs to separate YAML #34

Merged
merged 1 commit into from
Mar 7, 2024

Conversation

joverlee521
Copy link
Contributor

Description of proposed changes

It is unintuitive to have to remove default configs on the first run of the ingest workflow, so move the Nextclade configs to a separate config YAML that can be optionally used in nextstrain build.

Note that once the Nextclade dataset is stabilized for a pathogen, it then makes sense to move the configs into the default config.yaml

Related issue(s)

Prompted by nextstrain/docs.nextstrain.org#179

Checklist

  • Checks pass

It is unintuitive to have to remove default configs on the first run
of the ingest workflow, so move the Nextclade configs to a separate
config YAML that can be optionally used in `nextstrain build`.

Note that once the Nextclade dataset is stabilized for a pathogen,
it then makes sense to move the configs into the default config.yaml
Copy link
Contributor

@j23414 j23414 left a comment

Choose a reason for hiding this comment

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

Separating Nextclade configs into a distinct YAML file makes the "nextclade rules" an "opt-in" action. This makes sense because we anticipate users initiating the ingest process without an initial Nextclade dataset. I agree with you that later the user can merge it with the defaults/config.yaml if they so choose.

I was curious if you'd place the nextclade config in either "defaults" or "build-configs," and it appears you've picked the "defaults" directory.

LGTM!

@joverlee521
Copy link
Contributor Author

I was curious if you'd place the nextclade config in either "defaults" or "build-configs," and it appears you've picked the "defaults" directory.

TBH, I waffled on this for a bit! I've kept it in the defaults directory since we are pushing to include Nextclade in the core Nextstrain ingest workflows. The idea being that you should run the ingest workflow once without it, create a Nextclade workflow, then include the nextclade config in all future ingest workflow runs. It definitely doesn't work out as nicely right now (as we've learned with dengue 🙈) but my hope is this process will be streamlined in the future.

@joverlee521 joverlee521 merged commit a3d692b into main Mar 7, 2024
@joverlee521 joverlee521 deleted the move-ingest-nextclade branch March 7, 2024 01:09
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

Successfully merging this pull request may close these issues.

2 participants