Include a GitHub markdown file from a public repository
Example of including the
README.md available at https://github.com/githubtraining/exercise-enable-github-pages/blob/main/README.md.
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.
About this exercise
:warning: A grading script and a setup utility exist inside of the
:warning: 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.
:information_source: The use of GitHub Actions also means that it may take the grading workflow a few seconds and sometimes minutes to run.
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.
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
See Running a workflow on GitHub if you need assistance.
Use these to help you!
Resources specific to this exercise:
Resources for working with exercise and GitHub Actions in general:
<!-- Links used throughout this README: -->
Include GitHub pull requests from a public repository
Example of including the list of pull requests from the githubtraining/exercise-enable-github-pages public repository.
Include GitHub issues from a public repository
Example of including the list of issues from the githubtraining/exercise-enable-github-pages public repository.