Setting up your repository settings - jhudsl/OTTR_Template Wiki
Add jhudsl-robot as a collaborator
*You can skip this step if your course is in the
The Github actions in this repository need permissions to fully function.
To this end, you need to add the
jhudsl-robot as a collaborator on your repository with write permissions.
In your repository, go to your
Collaborators & Teams and click on
In the pop up window, search for and add
write option then click
Add jhudsl-robot to this repository.
Recommended repository settings
With your course repository set up, there are some settings recommended for development.
Using the issue guide checklist called
New Course - Set Repository Settings, you can walk through the steps for setting up your repository as we would recommend.
Set up GitHub pages
Source, pick the drop down menu and pick
- Then click
- Lastly, check the box that says
Enforce HTTPSat the bottom of this page.
Set up branches
* Don't set these settings right away! Wait a few minutes after starting your repository.
Branches and click
Add rule. This is only possible if you have GitHub Pro, Team, or Enterprise access. We recommend seeing if your organization can give you access if you do not already have access. To get this access through your organization, you will need to transfer ownership of your repo to your organization. See here about how to do this.
Branch name pattern, put
Protect the main branch:
Then check the box that says
Require pull requests before merging.
Make sure branches are updated:
- Check the box that says
Require status checks to pass before merging.
- Underneath this also check the box that says
Require branches to be up to date before merging.
After setting up these new branch items, click
After you submit a pull request if you haven't already done so, you will see several automatic checks happening. Don't be alarmed if this image looks slightly different as we make updates to the template:
These checks will do important things like:
- check that the all the urls actually take learners somewhere
- check that the code is styled using the
- check that the spelling is correct using the
- create previews of the rendered versions of the course
See the Github Actions page for more details on these.
If you are a part of JHU DaSL then you can skip the next section and the issue about GitHub secrets and start adding more content!
Otherwise, you will need to do the next section to set up Git Secrets.
There is one more issue that you can do to get updates for template files.
We recommend that you do this but it is optional.
See this section to learn more about this or continue following along with the guide which will tell you how to set this up in a bit.
Note that you can comment and close the issues you finish if you click on the issue and scroll down to the comment field to add comments and click the
close issue button if you are finished.