Welcome to the exercise on installing GitHub Apps!

This exercise checks your ability to manage GitHub Apps for your organization. It is automatically graded via a workflow once you have completed the instructions.

About this exercise

⚠️ A grading script exists under .github/workflows/grading.yml. You do not need to use this workflow for any purpose and altering its contents will affect the repository's ability to assess your exercise and give feedback.

⚠️ This exercise utilizes GitHub Actions, which is free for public repositories and self-hosted runners, but may incur charges on private repositories. See About billing for GitHub Actions to learn more.

ℹ️ The use of GitHub Actions also means that it may take the grading workflow a few seconds and sometimes minutes to run.

🔐 This exercise asks you to create a personal access token (PAT). This step is a prerequisite of the exercise, and you should already be comfortable with PATs on GitHub before proceeding. The PAT is encrypted and used only by a local action that does not leave your repository. GitHub has safeguards in place if the PAT is exposed by mistake, but you should know that if someone gains access to your PAT, they would have the same access you've given the token. To be safe, we recommend setting an expiration for the token. If you'd like to learn more about how your PAT is used, check the action's documentation in .github/actions/, Creating a personal access token in GitHub Docs, and Available scopes in GitHub Docs.

👥 This exercise needs to be completed in an organization. We recommend you create a new organization for free. If you choose to use an existing organization, note that this exercise will ask you to adjust settings in the organization that may have unintended effects on existing repositories or organization members.

Instructions

Please complete the instructions below:

1. Create an organization-owned copy of this repository using the Use this template button.
2. Create a personal access token (PAT) with the read:org scope selected.
3. Store the PAT as an organization secret titled EXERCISE_PAT. We recommend making the secret available only to your newly created repository.
4. Install a GitHub App of your choice on your organization and select only your repository as the installation target.
5. If your chosen GitHub App requires a configuration file, push that file to this repository to trigger the grading workflow. If your chosen GitHub App doesn't require configuration, push any commits to this repository or change and push changes to grading-config.yml to trigger the grading workflow.

Seeing your result

Your exercise is graded automatically once you have completed the instructions. To see the result of your exercise, go to the Issues tab, and look for an issue created by github-actions.

Below is an example of an incorrect solution and the feedback provided in the issue:

Troubleshooting

If you are stuck with a step in the exercise or the grading workflow does not automatically run after you complete the instructions, run the troubleshooter: in the Actions tab select the Grading workflow, click Run workflow, select the appropriate branch, and click the Run workflow button.

The troubleshooter will either display useful information to help you understand what you might have done wrong in your exercise or redirect you to the documentation relevant to your exercise to help you out.

See Running a workflow on GitHub if you need assistance.

Useful resources

Use these to help you!

Resources specific to this exercise:

• Installing a GitHub App in your organization in GitHub Docs

Resources for working with exercises and GitHub Actions in general:

• Creating a repository from a template
• Creating a personal access token in GitHub Docs
• Available scopes in GitHub Docs
• Encrypted secrets in Github Docs