-
Notifications
You must be signed in to change notification settings - Fork 14
Setting up GitHub secrets
The GitHub actions that this repository uses needs three GitHub secrets set up if you are not a part of the jhudsl
organization.
It's important that these are set up and named exactly what they are below in order for GitHub actions to work correctly.
See GitHub Actions section for how you can customize Github actions depending on the needs of the course you are working on.
To set up these repository secrets, on your repository's main GitHub page, go to Settings
and scroll down to see Secrets
on the left side menu bar.
For each new secret, click the New repository secret
button and set each as follows, clicking Add secret
as you fill each in appropriately:
Name: GH_PAT
:
*If you are a part of jhudsl
organization you do not need to set these.
For value
: Create a personal access token following these instructions. Underneath Select scopes
, check both repo
and workflow
.
Then copy the PAT and save as the value.
Note these are not required if Docker update GitHub actions are not turned on.
Read these instructions about how to set up a Docker image for your repository.
*If you are a part of jhudsl
organization or do not need a customized Docker image to render your content then you do not need to worry about setting these
These secrets must be set to Dockerhub login information for an account that has write access to the image you are using for the repository.
Name: DOCKERHUB_USERNAME
:
For value
: put your login username for https://hub.docker.com/
Name: DOCKERHUB_TOKEN
:
For value
: put a access token for Dockerhub.
You can create this by following these instructions.
If you encounter any problems or have ideas for improvements to this template repository or this getting started guide, please file an issue here! Your feedback is very much appreciated.
Note all materials in this template are licensed CC-BY and can be repurposed freely with attribution.
- Getting started
- Start a new course!
- Start editing course files
- Content creation tips
- Setting up images and videos
- About citations
- About Docker
- Spell check
- URL check
- Generate docx output
- Borrowing chapters between courses
- Most common errors
- Choosing between platforms
- Publishing with Bookdown
- Publishing on Coursera
- Publishing on Leanpub
- Making quizzes private (Leanpub and Coursera)
- Set up user feedback method
- Change title and style
- Credits section
- Adding Google Analytics Traffic Tracking
- Release a course for public viewing