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

Make qc.yml ODK managed by default #990

Merged
merged 2 commits into from
Feb 10, 2024
Merged

Conversation

matentzn
Copy link
Contributor

@matentzn matentzn commented Feb 8, 2024

This PR:

  • Makes qc.yml ODK-managed by default
  • Makes it possible to despense with the qc.yml from the beginning, by making it excludable in the config

Fixes #797

Also, make it possible to despense with the qc.yml from the beginning, by making it excludable in the config
Copy link
Contributor

@gouttegd gouttegd left a comment

Choose a reason for hiding this comment

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

Looks good overall, but we’ll need to warn users in the release notes of the following issue:

Suppose an ontology is using its own qc.yml file and does not have an explicit workflows key in its $(ONT)-odk.yml configuration file. When update_repo is run, the default value of workflows will be used, and will instruct the seeding process to overwrite the ontology’s own qc.yml with the ODK-provided one – something the ontology maintainers probably don’t want.

Sure, it’s up to whoever runs update_repo to check what files are changed and to revert any unwanted change (so in this case, revert to the original qc.yml file), but still it’d be nice to warn them in advance.

If you have your own qc.yml file (and you don’t want it replaced by the ODK qc), then before running update_repo:

  • rename your file to something other than qc.yml, or,
  • explicitly set the workflows variable in your $(ONT)-odk.yml and make sure it does not contain qc.

@gouttegd
Copy link
Contributor

gouttegd commented Feb 9, 2024

Or, maybe all ODK-maintained workflows should use a naming convention that makes it clear that they are ODK-maintained? Like qc-odk.yml, docs-odk.yml, etc.? This way users could have their own workflows without running the risk of a name clash with a ODK-maintained one.

@matentzn
Copy link
Contributor Author

Or, maybe all ODK-maintained workflows should use a naming convention that makes it clear that they are ODK-maintained? Like qc-odk.yml, docs-odk.yml, etc.? This way users could have their own workflows without running the risk of a name clash with a ODK-maintained one.

I think this would have been better, but now, what would happen is that all pipelines that update their system get a second QC activated.. I think its best to just roll with this for now, and make it very clear on the announcements. Probably though, the next actions should consider to be named odk-x.yaml - this is, indeed, much cleaner.

@matentzn matentzn merged commit eb16143 into master Feb 10, 2024
1 check passed
@matentzn matentzn deleted the make-qc-check-updating-default branch March 1, 2024 08:34
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.

Switch qc.yml to ODK managed
2 participants