Setting up GitHub secrets

Table of Contents generated with DocToc

• Github token
• Dockerhub related secrets

The OTTR robots need permissions to run some of the actions. You only need to do this once as an organization (if this course is under jhudsl you don't need to do this step).

To give them permission for all the actions, you need to set a GitHub secret. Go to Settings > Secrets.

If you are creating multiple courses underneath the same GitHub organization, you will only need to do this once if you set it as an Organization secret -- scroll to the bottom of the secrets page. Alternatively, you will need to do this for each repository and set a Repository secret. For each new secret, click the New secret button and set each as follows, clicking Add secret as you fill each in appropriately:

Github token

*If you are a part of jhudsl organization you do not need to set this.

Name: GH_PAT:
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.

Dockerhub related secrets

• 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.
• If you are unfamiliar with docker images, this chapter may be helpful for you.

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.

See GitHub Actions section for how you can customize Github actions depending on the needs of the course you are working on.