-
Notifications
You must be signed in to change notification settings - Fork 61
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(testing): document automated testing systems #475
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for getting this started! I've already got a testing.md file merged in docs, with a focus on contributor instructions on how to run tests.
I figure this content has several paths forward, a couple options I see:
- Rename to delivery.md, with the intent to expand into more deployment architecture content in follow-ups
- Rebase onto the merged testing.md, to explain more about automated testing systems after covering how to run tests
docs/testing.md
Outdated
|
||
These tests run against the `main` branch on a **nightly** basis. | ||
|
||
> **Note:** this is currently [in progress](https://github.com/GoogleCloudPlatform/emblem/issues/347) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're going to merge this in the docs, let's remove future things or hold this in waiting until it's true.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
馃憤 let's do the latter
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I linked to the (optional) installation-testing
directory instead.
I'll include a nightly build trigger (via Terraform) in there, via a separate PR.
This was my intent; my preference is to keep everything co-located in one place. |
LGTM. I will follow-up to rotate manual testing up and give the doc a top-level heading. |
I felt like our automated testing docs were a bit light, so I 馃 took the liberty 馃 of fleshing them out. 馃槃
BLOCKED on #347