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 README for some newly added packages #17283

Merged
merged 4 commits into from
Jul 14, 2021

Conversation

jennifer-shehane
Copy link
Member

  • Add README for runner-shared and runner-ct packages
  • Update codeowners so e2e team is reequested for review on changes to runner-shared, .github, and scripts

Additional Details

We want to ensure all newly added packages are properly documented for open source contributors and our own team by adding a README that describes:

  • What the package does.
  • How to work within the package to watch files and run tests.
  • Any other necessary info.

For a good example, see the reporter/README.md.

@jennifer-shehane jennifer-shehane requested a review from a team as a code owner July 12, 2021 14:00
@jennifer-shehane jennifer-shehane requested review from flotwig and kuceb and removed request for a team July 12, 2021 14:00
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jul 12, 2021

Thanks for taking the time to open a PR!

@jennifer-shehane jennifer-shehane requested review from a team and removed request for flotwig July 12, 2021 14:00
jennifer-shehane and others added 2 commits July 12, 2021 09:01

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Copy link
Contributor

@elevatebart elevatebart left a comment

Choose a reason for hiding this comment

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

Thank you @jennifer-shehane
This was indeed needed.

@lmiller1990 can you review the runner-shared readme

The rest is great with me.

@cypress
Copy link

cypress bot commented Jul 12, 2021



Test summary

18209 0 214 7Flakiness 4


Run details

Project cypress
Status Passed
Commit 028fa77
Started Jul 12, 2021 2:17 PM
Ended Jul 12, 2021 2:29 PM
Duration 11:22 💡
OS Linux Debian - 10.8
Browser Multiple

View run in Cypress Dashboard ➡️


Flakiness

cypress/integration/commands/net_stubbing_spec.ts Flakiness
1 network stubbing > intercepting response > does not overwrite the json-related content-type header
2 ... > automatically parses application/json response bodies
3 ... > sets body to string if JSON is malformed
4 network stubbing > waiting and aliasing > can timeout waiting on a single request using "alias.request"

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@@ -19,9 +20,11 @@
/packages/rewriter/ @cypress-io/test-runner
/packages/root/ @cypress-io/test-runner
/packages/runner/ @cypress-io/test-runner
/packages/runner-shared/ @cypress-io/test-runner
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also add a runner-ct code owner and respective GH team?

Copy link
Member Author

Choose a reason for hiding this comment

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

@lmiller1990 Yah, was leaving that to the CT team to decide if you want to have your team pinged whenever the code is touched in the packages you 'own'. It's been working well for us because things opened by outside contributors or other teams is pretty obvious if it touches something we should look at without looking through all the files.

@jennifer-shehane jennifer-shehane merged commit 5ced6ab into develop Jul 14, 2021
@emilyrohrbough emilyrohrbough deleted the runner-shared-misc branch August 1, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants