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

Need explanation of how to run tests in rest-api-spec test guide #88406

Closed
chen-ni opened this issue Jul 10, 2022 · 3 comments · Fixed by #88490
Closed

Need explanation of how to run tests in rest-api-spec test guide #88406

chen-ni opened this issue Jul 10, 2022 · 3 comments · Fixed by #88490
Labels
:Delivery/Tooling Developer tooliing and automation Team:Delivery Meta label for Delivery team

Comments

@chen-ni
Copy link
Contributor

chen-ni commented Jul 10, 2022

The rest-api-spec tests guide is confusing because after all the explanations of the test file structure, it doesn't tell us how to actually RUN an individual test or a test suite.

Luckily for me, I happened to run into this comment that explains how to run such a test.

It would be better if we could add an explanation of how to run tests (or a link to some doc located elsewhere) to the guide. It won't be much work but would save a lot of time for the developers.

I'd be glad to create a PR for this.

@DJRickyB DJRickyB added the :Delivery/Tooling Developer tooliing and automation label Jul 12, 2022
@elasticmachine elasticmachine added the Team:Delivery Meta label for Delivery team label Jul 12, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@mark-vieira
Copy link
Contributor

We have a whole separate README specifically about test execution. It might be as simple as just linking to this section from the rest-api-spec guide.

@chen-ni
Copy link
Contributor Author

chen-ni commented Jul 12, 2022

@mark-vieira Thanks, I'll create a PR adding the link :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Tooling Developer tooliing and automation Team:Delivery Meta label for Delivery team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants