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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(testing): document automated testing systems #475

Merged
merged 6 commits into from
Jun 10, 2022
Merged

Conversation

ace-n
Copy link
Contributor

@ace-n ace-n commented Jun 3, 2022

I felt like our automated testing docs were a bit light, so I 馃 took the liberty 馃 of fleshing them out. 馃槃

BLOCKED on #347

@ace-n ace-n requested review from engelke and grayside June 3, 2022 23:04
@ace-n ace-n self-assigned this Jun 3, 2022
@ace-n ace-n requested a review from a team as a code owner June 3, 2022 23:04
@github-actions github-actions bot added component: demo services Related to interactive learning using the app. documentation Improvements or additions to documentation labels Jun 3, 2022
Copy link
Collaborator

@grayside grayside left a 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)
Copy link
Collaborator

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.

Copy link
Contributor Author

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

Copy link
Contributor Author

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.

docs/testing.md Show resolved Hide resolved
@ace-n
Copy link
Contributor Author

ace-n commented Jun 7, 2022

Rebase onto the merged testing.md, to explain more about automated testing systems after covering how to run tests

This was my intent; my preference is to keep everything co-located in one place.

@ace-n ace-n added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jun 7, 2022
@ace-n ace-n marked this pull request as draft June 8, 2022 01:44
@ace-n ace-n marked this pull request as ready for review June 10, 2022 00:09
@ace-n ace-n requested a review from grayside June 10, 2022 00:09
@ace-n ace-n dismissed grayside鈥檚 stale review June 10, 2022 00:10

Requesting subsequent review :)

@ace-n ace-n removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jun 10, 2022
@grayside
Copy link
Collaborator

LGTM. I will follow-up to rotate manual testing up and give the doc a top-level heading.

@ace-n ace-n merged commit 5c8224c into main Jun 10, 2022
@ace-n ace-n deleted the ace-n-patch-8 branch June 10, 2022 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: demo services Related to interactive learning using the app. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants