https://github.com/githubtraining/exercise-check-installed-apps
A hands-on exercise using GitHub Actions. See README.md for instructions on how to get started.
https://github.com/githubtraining/exercise-check-installed-apps
exercise
Last synced: 8 months ago
JSON representation
A hands-on exercise using GitHub Actions. See README.md for instructions on how to get started.
- Host: GitHub
- URL: https://github.com/githubtraining/exercise-check-installed-apps
- Owner: githubtraining
- License: cc-by-4.0
- Created: 2021-08-31T16:34:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-14T11:38:45.000Z (over 2 years ago)
- Last Synced: 2023-06-15T01:15:29.531Z (over 2 years ago)
- Topics: exercise
- Language: JavaScript
- Homepage:
- Size: 75.2 KB
- Stars: 15
- Watchers: 0
- Forks: 39
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
:warning: 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.**
:warning: This exercise utilizes [GitHub Actions](https://docs.github.com/en/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.
:information_source: The use of GitHub Actions also means that it may take the grading workflow a few seconds and sometimes minutes to run.
:closed_lock_with_key: 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/`](.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](https://github.com/account/organizations/new?coupon=&plan=team_free) 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](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) button.
2. Create a personal access token (PAT) with the `read:org` scope selected.
3. Store the PAT as an [organization secret](https://docs.github.com/en/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces#adding-secrets-for-an-organization) 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`](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]
[_Installing a GitHub App in your organization_ in GitHub Docs]: https://docs.github.com/en/github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization#installing-a-github-app-in-your-organization
[creating a repository from a template]: https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
[_Creating a personal access token_ in GitHub Docs]: https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token
[_Available scopes_ in GitHub Docs]: https://docs.github.com/en/developers/apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes
[_Encrypted secrets_ in Github Docs]: https://docs.github.com/en/actions/reference/encrypted-secrets
[about billing for github actions]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions
[running a workflow on github]: https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow-on-github