TEMPLATE repository for live demos associated with the Childhood Cancer Data Lab workshop on advanced git
/GitHub topics and analytical code review.
Instructor notes for how to lead the live demos are available in .live-demo-content/instructor-notes
.
Reference scripts that are written during live demos are available in .live-demo-content/scripts
.
There are several tasks which need to be performed before this workshop begins, as detailed below.
Under Settings -> Branches
, add a new branch protection rule for main
with the following options turned on:
- Require a pull request before merging
- The nested item Require approvals
- Do not allow bypassing the above settings
The individual leading the live demonstration teaching stacking and forks should have a fork created before the workshop starts. Optionally, the fork can be cloned, or this can be shown during the workshop.
- The github action can be manually triggered to file issues.
- When running this action, you can optionally specify two inputs of github usernames to set as assignees.
If you do not provide these inputs, you will have to manually assign the resulting issues.
- The
demo_lead_username
input should take the username to assign to all issues except the issue associated with demonstrating PR review. - The
demo_support_username
input should take the username to assign only to the issue associated with demonstrating PR review.
- The
Two branches will need to be created in advance to support the "Working with branches" live demonstration.
These branches should be created off of main
and should be named as follows, where <username>
is the GitHub handle of who will be performing the demonstration, and <issue number>
is the number of the relevant issue that is filed from the issue creation GHA.
<username>/<issue number>-penguins-species-count
is the branch used to address the issue.live-demo-content/issue-templates/03-working-with-branches.md
.<username>/<issue number>-penguins-species-mass
is the branch used to address the issue.live-demo-content/issue-templates/04-working-with-branches.md
.
- Whoever is assigned the issue associated with demonstrating PR review will need to prepare a branch and file a PR, with several commits (whose messages have varying levels of information), that will be reviewed during the live demonstration.
- This branch should ultimately modify the contents of this baseline notebook to match this updated notebook.
- A PR should then be filed to
main
, using the text in.live-demo-content/spotify-pr-text.md
.