Skip to content

Commit fbf255c

Browse files
Update to 1 in STEP and README.md
1 parent c612c17 commit fbf255c

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

.github/steps/-step.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0
1+
1

README.md

+34-34
Original file line numberDiff line numberDiff line change
@@ -14,50 +14,50 @@ _Create workflows that enable you to use Continuous Integration (CI) for your pr
1414
</header>
1515

1616
<!--
17-
<<< Author notes: Course start >>>
18-
Include start button, a note about Actions minutes,
19-
and tell the learner why they should take the course.
17+
<<< Author notes: Step 1 >>>
18+
Choose 3-5 steps for your course.
19+
The first step is always the hardest, so pick something easy!
20+
Link to docs.github.com for further explanations.
21+
Encourage users to open new tabs for steps!
2022
-->
2123

22-
## Welcome
24+
## Step 1: Add a test workflow
2325

24-
[Continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) can help you stick to your team’s quality standards by running tests and reporting the results on GitHub. CI tools run builds and tests, triggered by commits. The results post back to GitHub in the pull request. The goal is fewer issues in `main` and faster feedback as you work.
26+
_Welcome to "GitHub Actions: Continuous Integration"! :wave:_
2527

26-
- **Who is this for**: Developers, DevOps Engineers, new GitHub users, students, teams.
27-
- **What you'll learn**: What continuous integration is, how to use GitHub Actions for CI, how to create a workflow that runs tests and produces test reports.
28-
- **What you'll build**: We'll use [remark-lint](https://github.com/remarkjs/remark-lint) to check the consistency of Markdown files.
29-
- **Prerequisites**: We assume you've completed [Hello GitHub Actions](https://github.com/skills/hello-github-actions) first.
30-
- **How long**: This course takes less than two hours to complete.
28+
**What is _continuous integration_?**: [Continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) can help you stick to your team’s quality standards by running tests and reporting the results on GitHub. CI tools run builds and tests, triggered by commits. The quality results post back to GitHub in the pull request. The goal is fewer issues in `main` and faster feedback as you work.
3129

32-
In this course, you will:
30+
![An illustration with a left half and a right half. On the left: illustration of how GitHub Actions terms are encapsulated. At the highest level: workflows and event triggers. Inside workflows: jobs and definition of the build environment. Inside jobs: steps. Inside steps: a call to an action. On the right: the evaluated sequence: workflow, job, step, action.](https://user-images.githubusercontent.com/6351798/88589835-f5ce0900-d016-11ea-8c8a-0e7d7907c713.png)
3331

34-
1. Add a test workflow
35-
2. Fix the test
36-
3. Upload a test report
37-
4. Add branch protections
38-
5. Merge your pull request
32+
- **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.
33+
- **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.
34+
- **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.
35+
- **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!
3936

40-
### How to start this course
37+
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.
4138

42-
<!-- For start course, run in JavaScript:
43-
'https://github.com/new?' + new URLSearchParams({
44-
template_owner: 'skills',
45-
template_name: 'test-with-actions',
46-
owner: '@me',
47-
name: 'skills-test-with-actions',
48-
description: 'My clone repository',
49-
visibility: 'public',
50-
}).toString()
51-
-->
39+
First, let's add a workflow to lint (clean, like a lint roller) our Markdown files in this repository.
5240

53-
[![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=skills&template_name=test-with-actions&owner=%40me&name=skills-test-with-actions&description=My+clone+repository&visibility=public)
41+
### :keyboard: Activity: Add a test workflow
5442

55-
1. Right-click **Start course** and open the link in a new tab.
56-
2. In the new tab, most of the prompts will automatically fill in for you.
57-
- For owner, choose your personal account or an organization to host the repository.
58-
- 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).
59-
- Scroll down and click the **Create repository** button at the bottom of the form.
60-
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.
43+
1. Open a new browser tab, and work through the following steps in that tab while you read the instructions in this tab.
44+
1. Go to the **Actions tab**.
45+
1. Click **New workflow**.
46+
1. Search for "Simple workflow" and click **Configure**.
47+
1. Name your workflow `ci.yml`.
48+
1. Update the workflow by deleting the last two steps.
49+
1. Add the following step at the end of your workflow:
50+
```yml
51+
- name: Run markdown lint
52+
run: |
53+
npm install remark-cli remark-preset-lint-consistent
54+
npx remark . --use remark-preset-lint-consistent --frail
55+
```
56+
> Even after the code is indented properly in `ci.yml`, you will see a build error in GitHub Actions. We'll fix this in the next step.
57+
1. Click **Commit changes...**, and choose to make a new branch named `ci`.
58+
1. Click **Propose changes**.
59+
1. Click **Create pull request**.
60+
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.
6161

6262
<footer>
6363

0 commit comments

Comments
 (0)