https://github.com/githubtraining/exercise-enable-github-pages
A hands-on exercise using GitHub Actions. See README.md for instructions on how to get started.
https://github.com/githubtraining/exercise-enable-github-pages
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-enable-github-pages
- Owner: githubtraining
- License: cc-by-4.0
- Archived: true
- Created: 2021-01-20T13:26:32.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-18T19:38:45.000Z (over 3 years ago)
- Last Synced: 2025-03-25T07:27:47.878Z (10 months ago)
- Topics: exercise
- Language: JavaScript
- Homepage:
- Size: 85 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to the exercise on enabling GitHub Pages!
This exercise is an exercise to check your knowledge on enabling GitHub Pages. It is automatically graded via a workflow once you have completed the instructions.
**Quick links:**
- [About this exercise](#about-this-exercise)
- [Instructions](#instructions)
- [Seeing your result](#seeing-your-result)
- [Troubleshooting](#troubleshooting)
- [Useful resources](#useful-resources)
## About this exercise
:warning: A grading script and a setup utility exist inside of the `.github/` directory. You do not need to use these workflows for any purpose and **altering their 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.
## Instructions
1. Create your own copy of this repository by 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. Make sure you set your repository visibility to **Public** when asked.
2. In your newly created repository, enable GitHub Pages with the `main` branch and the `docs/` directory as the source for the GitHub Pages site.
## Seeing your result
Your exercise is graded automatically once you have completed the instructions. To see the result of your exercise, click the **Actions** tab, select the **Grading workflow**, and select the most recent workflow run. The status of the workflow indicates if you have passed or failed the exercise.
If the workflow failed, scroll down to the **Annotations** section to check what went wrong.
See *[Viewing workflow run history]* if you need assistance.
## Troubleshooting
If 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 (usually `main`), and click the **Run workflow** button.
See *[Running a workflow on GitHub]* if you need assistance.
## Useful resources
Use these to help you!
Resources specific to this exercise:
- [Configuring a publishing source for your GitHub Pages site]
Resources for working with exercise and GitHub Actions in general:
- [Creating a repository from a template]
- [Viewing workflow run history]
- [Running a workflow on GitHub]
- [About billing for GitHub Actions]
- [GitHub Actions]
[Configuring a publishing source for your GitHub Pages site]: https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
[Creating a repository from a template]: https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
[Viewing workflow run history]: https://docs.github.com/en/actions/managing-workflow-runs/viewing-workflow-run-history
[Running a workflow on GitHub]: https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow-on-github
[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
[GitHub Actions]: https://docs.github.com/en/actions