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

Should pipeline test config be in YAML? #106

Closed
7 tasks done
ycombinator opened this issue Jan 12, 2021 · 5 comments
Closed
7 tasks done

Should pipeline test config be in YAML? #106

ycombinator opened this issue Jan 12, 2021 · 5 comments
Assignees
Labels
discuss Issue needs discussion

Comments

@ycombinator
Copy link
Contributor

ycombinator commented Jan 12, 2021

The system test configuration is expressed as YAML and many other package files are also expressed as YAML. However, pipeline test configuration files (example: https://github.com/elastic/package-spec/blob/master/code/go/internal/validator/test/packages/good/data_stream/foo/_dev/test/pipeline/test-access-raw.log-config.json) is expressed as JSON. Should we change this to be YAML as well?

Rollout plan for this change

  • Enhance package spec to allow *.yml pipeline test configuration files in addition to the currently-allowed *.json ones. Mark the *.json file format as deprecated (exactly how to do this is TBD). This will give package authors some time to adjust their pipeline test configuration file formats: Deprecating JSON-formatted pipeline test configs in favor of YAML-formatted ones #139.
  • Update all pipeline test configuration files in the integrations repo from *.json => *.yml: Replacing .json pipeline test config files with .yml ones integrations#739.
  • Notify package stakeholders that *.json pipeline test configuration files are being removed and replaced by *.yml ones.
  • After a few weeks:
    • Notify package stakeholders that support for *.json pipeline test configuration files is being removed.
    • Remove support for *.json pipeline test configuration files from package spec: Remove pipeline test config json #150.
    • Notify package stakeholders that support for *.json pipeline test configuration files has been removed.
@ycombinator ycombinator added the discuss Issue needs discussion label Jan 12, 2021
@andrewkroh
Copy link
Member

I noticed this inconsistency and was wondering about it. +1 for using YAML for both.

@ycombinator ycombinator self-assigned this Feb 19, 2021
@ycombinator
Copy link
Contributor Author

I'm going ahead with this change now. I've updated the issue description with a plan on how to roll out this change safely. Please review it.

@mtojek
Copy link
Contributor

mtojek commented Mar 16, 2021

@ycombinator I think you can move forward with this issue.

@ycombinator
Copy link
Contributor Author

Thanks for the reminder, @mtojek. I'll move this forward today.

@ycombinator
Copy link
Contributor Author

All steps in the rollout plan (see issue description) are now done. Closing.

rw-access pushed a commit to rw-access/package-spec that referenced this issue Mar 23, 2021
* Update dependency on package-spec

* Fix: make check
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issue needs discussion
Projects
None yet
Development

No branches or pull requests

3 participants