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

docs: Add more details to the test framework README #1343

Merged
merged 4 commits into from
Oct 9, 2023

Conversation

p-offtermatt
Copy link
Contributor

Description

Closes: N/A, minor change

Adds more information about how to run and generate traces for the e2e framework,
as suggested by @sainoe


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@p-offtermatt p-offtermatt requested a review from a team as a code owner October 6, 2023 15:25
@github-actions github-actions bot added the C:Testing Assigned automatically by the PR labeler label Oct 6, 2023
tests/e2e/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sainoe sainoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Contributor

@shaspitz shaspitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment but looks solid!

@@ -0,0 +1,3 @@
#!/bin/sh

go test -timeout 30s -run ^TestWriteExamples$ github.com/cosmos/interchain-security/v3/tests/e2e
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this'd be more appropriate as a make target

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, good call

@github-actions github-actions bot added the C:Build Assigned automatically by the PR labeler label Oct 9, 2023
@p-offtermatt p-offtermatt merged commit c25b4c0 into main Oct 9, 2023
14 checks passed
@p-offtermatt p-offtermatt deleted the ph/test-readme branch October 9, 2023 08:05
MSalopek pushed a commit that referenced this pull request Dec 1, 2023
* Add more details to the test framework README

* Add regnerate_traces file

* Add make target for e2e traces

* Remove regenerate-traces script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Build Assigned automatically by the PR labeler C:Testing Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants