-
Notifications
You must be signed in to change notification settings - Fork 1k
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] How to test in GitHub actions #6921
Conversation
@esteban-url please see the PR I submitted against your fork. I performed basic edits and left a couple PR comments. General question: What is the recommended way to contribute/edit files associated with somebody else's PR? Here's how I did it (as a noob that is figuring it out)... Created my own fork of redwoodjs/redwood, checked out the test-in-github-actions branch, renamed it, edited the article, pushed it to my forked repo, then submit a PR to esteban-url. Seems a bit round-about, but I think it works. I also tried to push commits directly (instead of creating a PR, but I got 403 errors). Thanks for helping me work through the GitHub flow! |
@esteban-url looks great so far! thanks for all the hard work.
This is generally the way to do it.
Unless you have been explicitly granted authorized access to a repo you don't own, this is the expected behavior. |
@keithtelliott thanks a bunch! I check out your PR, and look into granting you the necessary access to my repo. |
Edit intro section. Adjust/refine wording, but not the core themes.
@virtuoushub Thanks for checking out the PR and provinding the answers to Keiths questions! |
Co-authored-by: Peter Colapietro <[email protected]>
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.
this is a great addition to the docs! tysm.
@esteban-url I worked through the How To and ran my unit tests within GitHub Actions. It just worked! Your technical description successfully guided me through the required steps. So, I did not add/adjust the technical details. I did, however, add a callout note mid-way through, and a summary conclusion at the end. My goal: encourage the reader. As with my prior contribution, I submitted a PR to you, on your esteban-url fork. Please review/edit/merge as you see fit. |
thanks @jtoar, I saw the error on the first commit, but thought it was maybe one of those "expected" errors. At the time I removed emojis and something else. I can help trying to figure it out, but how can I test this locally? |
@esteban-url the errors you get from docusaurus locally aren't super great; you just need a mental model of what's going in the file. So this file is MDX, which means it's markdown and react. But really it's all react—so a build error usually means there's a react error. In this case it's just that you forgot to close the |
Thanks! That makes a lot of sense. I'll keep it in mind for my next docs PR! |
@esteban-url reading through now and making some edits I'll push up as I go—great stuff! I'll focus on getting this merged today. |
Thanks! yeah, feel free to edit anything. |
Again, great stuff @esteban-url! And thanks for letting me have at it a bit. The diff of edits may look large, but it was just polishing, made easier by the great structure that was already there. A few tips for the future:
|
* add test in github actions * add images * remove emoji * remove slug * Edit intro section. Adjust/refine wording, but not the core themes. * Refine wording in the body of the article * Update docs/docs/how-to/test-in-github-actions.md Co-authored-by: Peter Colapietro <[email protected]> * Add callout note and conclusion * Fix spelling error * Fix spelling error, again * fix: close image tags * fix: capitalize the "h" in GitHub * round of edits Co-authored-by: Keith Elliott <[email protected]> Co-authored-by: Peter Colapietro <[email protected]> Co-authored-by: Dominic Saadi <[email protected]>
* add test in github actions * add images * remove emoji * remove slug * Edit intro section. Adjust/refine wording, but not the core themes. * Refine wording in the body of the article * Update docs/docs/how-to/test-in-github-actions.md Co-authored-by: Peter Colapietro <[email protected]> * Add callout note and conclusion * Fix spelling error * Fix spelling error, again * fix: close image tags * fix: capitalize the "h" in GitHub * round of edits Co-authored-by: Keith Elliott <[email protected]> Co-authored-by: Peter Colapietro <[email protected]> Co-authored-by: Dominic Saadi <[email protected]>
* add test in github actions * add images * remove emoji * remove slug * Edit intro section. Adjust/refine wording, but not the core themes. * Refine wording in the body of the article * Update docs/docs/how-to/test-in-github-actions.md Co-authored-by: Peter Colapietro <[email protected]> * Add callout note and conclusion * Fix spelling error * Fix spelling error, again * fix: close image tags * fix: capitalize the "h" in GitHub * round of edits Co-authored-by: Keith Elliott <[email protected]> Co-authored-by: Peter Colapietro <[email protected]> Co-authored-by: Dominic Saadi <[email protected]>
…xperimental-vite-optin * 'main' of github.com:redwoodjs/redwood: (27 commits) fix(deps): update dependency @types/node to v16.18.9 (#7140) fix(deps): update dependency vscode-languageserver-textdocument to v1.0.8 (#7132) fix: add cli-helpers as dep (#7141) remove deprecated auth providers (#7138) chore: update test project fixture dbauth packages (#7139) NavLink not highlighting when on sub pages (#6939) Rename create auth functions (#7137) Export underlying cache client with Service Cache functions (#7062) fix(deps): update dependency @simplewebauthn/browser to v6.2.2 (#7103) fix(deps): update dependency msw to v0.49.2 (#7126) chore(deps): update dependency nx to v15.3.3 (#7125) fix(deps): update docusaurus monorepo to v2.2.0 (#7116) [docs] How to test in GitHub actions (#6921) fix(deps): update typescript-eslint monorepo to v5.46.1 (#7109) Codemod to include full-name in test-project signup (#7124) Rebuild test-project fixture (#7123) feat: add CustomValidator (#7051) dbAuthClient (#7111) chore(deps): update dependency nx to v15.3.2 (#7114) chore(deps): update dependency redis to v4.5.1 (#7115) ...
This PR creates a how to section on How to have Github actions test your redwood app