Updates to the Developer Guide (Testing & Extending sections) #432
Conversation
sarina
changed the title
|
@feanil is there someone you can think of to review this that would know about testing & github actions? |
sarina
force-pushed
the
sarina/more-dev-guide
branch
2 times, most recently
from
5f99e7b to
99e15ee
Compare
|
Someone on arch-bom/arbi-bom at 2U might be a good candidate for that. @jmbowman do you have someone that you could recommend? |
sarina
force-pushed
the
sarina/more-dev-guide
branch
4 times, most recently
from
2d3bf67 to
e0d85c9
Compare
|
@feanil it's been 5 months but I have addressed Jeremy's one comment and got the build working again. \o/ I'll tag @brian-smith-tcril - Brian, you and I fixed up a good portion of the dev guide together. Any desire to take a run through this? |
| repository, or deploy merged pull requests to production. | ||
|
|
||
| The Open edX project uses Actions to automate test builds on pull requests, as | ||
| well as to create other types of automations. You can check out the workflows |
There was a problem hiding this comment.
as well as to create other types of automations
Maybe we could copy the first 2 paragraphs of the "Understanding GitHub Actions" page and make it clear we're directly quoting them, then expand this to be:
The Open edX project uses Actions to automate test builds on pull requests,
**manage/organize issues on project boards? something like that?**, and more!| available to all Open edX repositories in the `.github repo`_; many repos define | ||
| their own workflows in their ``.github/workflows`` directory. | ||
|
|
||
| Reading Builds |
There was a problem hiding this comment.
"Reading Builds" feels like odd phrasing to me. Maybe "Reading Build Status" or something?
There was a problem hiding this comment.
I'm having a hard time understanding the purpose of this file. It seems to be serving as an introduction to GitHub Actions as a concept, an overview of how GitHub Actions are used throughout the Open edX GH org, but also a couple how-tos for troubleshooting specific checks (GH Actions and otherwise) that exist on most repos.
I feel like we'd benefit from having:
- What are GitHub Actions?
- How are GitHub Actions used in the Open edX project?
- How to troubleshoot? automated checks on repos in the Open edX project.
There was a problem hiding this comment.
I restructured the document to have these three "sections" in this doc. I think it's a good framing.
sarina
force-pushed
the
sarina/more-dev-guide
branch
from
e0d85c9 to
59ea19c
Compare
Removed outdated information and added appropriate crosslinking of documents
sarina
force-pushed
the
sarina/more-dev-guide
branch
from
59ea19c to
a47e82f
Compare
sarina
force-pushed
the
sarina/more-dev-guide
branch
from
0cafc92 to
1e701bd
Compare
Updates some small typos, adds a section on GitHub Actions, and removes some outdated references related to testing and XBlocks