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

[Feature Request] Support validation_packages.yml #211

Closed
kMutagene opened this issue Jul 8, 2024 · 1 comment
Closed

[Feature Request] Support validation_packages.yml #211

kMutagene opened this issue Jul 8, 2024 · 1 comment
Assignees
Labels

Comments

@kMutagene
Copy link
Member

kMutagene commented Jul 8, 2024

This week will see a rollout of the new Continuous Quality Control pipelines on the DataHUB. This means that all ARCs using the old validation pipelines will need an update that moves them to using the new validation_packages.yml config file to opt-in for user-selected validation packages.

While POCs of this exist across the ARCtrl stack and a manual migration guide will be uploaded, the ARCitect as the central tool must support this feature to some extent on launch. This will be on 2024-07-10, so time is of essence.

I suggest we only ship a bare-bones editing feature for this file to make the deadline here. This means:

  • ARCtrl:
    • Data model for validation packages
    • Reader/Writer functions for the file
    • Top-level API
  • ARCitect:
    • Simple key-value UI component that maps the allowed keys specified here and makes their values editable

I will take care of the ARCtrl side and update this issue with usage examples of the API. I suggest that the UI component can be created in parallel, with the backend using the new API once provided.

@github-actions github-actions bot added the Status: Needs Triage This item is up for investigation. label Jul 8, 2024
@kMutagene kMutagene added Critical and removed Status: Needs Triage This item is up for investigation. labels Jul 8, 2024
@kMutagene kMutagene moved this to In progress in ARCStack Jul 8, 2024
@kMutagene kMutagene moved this from In progress to Backlog in ARCStack Jul 8, 2024
@kMutagene kMutagene moved this from Backlog to In progress in ARCStack Jul 8, 2024
@JonasLukasczyk
Copy link
Collaborator

Hi everyone,
f17eb22 adds this functionality, specifically:

  1. ARCitect now has a "Validation" item in the left menu which opens the new ValidationView (see below).
  2. In this view users can choose to validate against the arc specification with a specific version (currently there is only one option).
  3. They can also choose or enter custom validation packages where swagger provides suggestions for names and corresponding versions (currently there exists only one custom target but with several versions).
  4. On pressing the save button the form will be converted into a YML file and stored in arc_root/.arc/validation_packages.yml.
  5. When the Validation View is opened ARCitect will look for an existing YML file and populate the form accordingly.
  6. Still needs to be tested
  7. Currently all this functionality is implemented in ARCitect and does not use ARCtrl. I will close the issue for now and open a new issue to keep track of moving this functionality to ARCtrl.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

No branches or pull requests

2 participants