Skip to content

Commit

Permalink
Correct the instructions (#55)
Browse files Browse the repository at this point in the history
* Fix wording

* Delete the confusing hint
  • Loading branch information
sinsukehlab committed Jan 3, 2024
1 parent cce1a50 commit 0471289
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/steps/1-add-a-test-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ _Welcome to "GitHub Actions: Continuous Integration"! :wave:_
- **Workflow**: A workflow is a unit of automation from its start to finish, including the definition of what triggers the automation, what environment or other aspects should be taken into account during the automation, and what should happen as a result of the trigger.
- **Job**: A job is a section of the workflow, and is made up of one or more steps. In this section of our workflow, the template defines the steps that make up the `build` job.
- **Step**: A step represents one _effect_ of the automation. A step could be defined as a GitHub Action, or another unit, like printing something to the console.
- **Action**: An action is a piece of automation written in a way that is compatible with workflows. Actions can be written by GitHub, by the open source community, and you can write them yourself!
- **Action**: An action is a piece of automation written in a way that is compatible with workflows. Actions can be written by GitHub, by the open source community, or you can write them yourself!

To learn more, check out [Workflow syntax for GitHub Actions](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions) in the GitHub Docs.

Expand Down
5 changes: 1 addition & 4 deletions .github/steps/2-fix-the-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ If the checks don't appear or if the checks are stuck in progress, there's a few

### :keyboard: Activity: Fix the test

1. Update the code in the `ci` branch to get the test to pass. You need to look something like this:
```markdown
_underscore_
```
1. Update the contents in the `ci` branch to get the test to pass. You need to look at the logs to see what caused the test to fail.
1. **Commit changes**.
1. Wait about 20 seconds and then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/actions) will automatically update to the next step.
2 changes: 1 addition & 1 deletion .github/steps/4-add-branch-protections.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ Protected branches ensure that collaborators on your repository cannot make irre
1. Uncheck **Require approvals**.
1. Check **Require status checks to pass before merging**.
1. Check all build and test jobs that you'd like to see in the newly visible gray box.
1. Click **Save changes**.
1. Click **Create**.
1. _Once you turn on branch protection, Actions can no longer push directly to the `main` branch. Wait about 20 seconds and then go to the `ci` branch. [GitHub Actions](https://docs.github.com/actions) will automatically update to the next step on the `ci` branch. You'll need to follow instructions on this branch._
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ In this course, you will:
2. In the new tab, most of the prompts will automatically fill in for you.
- For owner, choose your personal account or an organization to host the repository.
- We recommend creating a public repository, as private repositories will [use Actions minutes](https://docs.github.com/billing/managing-billing-for-github-actions/about-billing-for-github-actions).
- Scroll down and select the **Create repository** button at the bottom of the form.
- Scroll down and click the **Create repository** button at the bottom of the form.
3. After your new repository is created, wait about 20 seconds, then refresh the page. Follow the step-by-step instructions in the new repository's README.

<footer>
Expand Down

0 comments on commit 0471289

Please sign in to comment.