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

[RFE]: Provide full schema docs for presubmit.yml #2364

Open
jsharpe opened this issue Jul 4, 2024 · 3 comments · Fixed by #2366
Open

[RFE]: Provide full schema docs for presubmit.yml #2364

jsharpe opened this issue Jul 4, 2024 · 3 comments · Fixed by #2366
Labels
bug Something isn't working

Comments

@jsharpe
Copy link
Contributor

jsharpe commented Jul 4, 2024

What happened?

Changes requested to presubmit.yml in PR review; schema of file / best practice has changed since last submission of module

Version

N/A

How to reproduce

No response

Any other information?

Docs currently link to CI repo for reference for presubmit.yml but its not really documented there. Docs provide some examples but there is not a full reference of all valid keys / structure that the code can parse.
Workaround tends to be to find a similar module and copy presubmit.yml from them instead of having reference documentation to construct a file from scratch from.

@jsharpe
Copy link
Contributor Author

jsharpe commented Jul 4, 2024

Note that https://github.com/bazelbuild/continuous-integration/tree/master/buildkite#configuring-a-pipeline is not a full specification for the format - its documentation by example; it doesn't list for instance the valid sets of keys under each section within the yaml file.

@jsharpe
Copy link
Contributor Author

jsharpe commented Jul 9, 2024

@Wyverald I don't think that PR resolves this RFE - it doesn't provide a full schema definition for the yaml file; I want a complete set of valid keys under each section documented. Please reopen this issue.

@Wyverald Wyverald reopened this Jul 9, 2024
@Wyverald
Copy link
Member

Wyverald commented Jul 9, 2024

@meteorcloudy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants