You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-19Lines changed: 15 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Exploring CI/CD with a Profile README.md
2
2
3
3
[Profile READMEs](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme) are a fun easter egg on GitHub. If you create a
4
-
repository on your personal account, with the same name as your username,
4
+
repository on your personal account with the same name as your username,
5
5
the `README.md` in this repository will be displayed on your profile page.
In this hands on lab, we explore the topic of CI/CD using
9
+
In this hands on workshop, we explore the topic of CI/CD using
10
10
[GitHub Actions](https://docs.github.com/en/actions) and your Profile README.md.
11
11
12
12
## The Workshop
@@ -38,10 +38,9 @@ account with the same name as your username:
38
38
39
39
### Personalize your profile page
40
40
41
-
Let's personalize bio that you used as a template:
41
+
Let's personalize your biography:
42
42
43
-
1. Clone the repository you've just created (_I recommend using
44
-
the [ssh](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) option, when cloning a repository_).
43
+
1. Clone the repository you've just created (_I recommend using [ssh](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)_).
3. Replace the contents of `README.md` with the contents of `README.example.md`.
@@ -59,7 +58,7 @@ Having made your changes locally, push them to GitHub and open a pull request:
59
58
60
59
1.`git commit -a -m 'docs: update bio to reflect myself'`.
61
60
2.`git push origin personalize`.
62
-
3. Visit GitHub and [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request),**Don't merge the pull request immediately**.
61
+
3. Visit GitHub and [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).**Don't merge the pull request immediately**.
63
62
64
63
### Look closely at your pull request
65
64
@@ -95,12 +94,12 @@ When you created your repository, it included the file `.github/workflows/ci.yam
95
94
- run: npm test
96
95
```
97
96
98
-
This file describes a GitHub Action workflow, which will run unit tests when
99
-
a pull request is open.
100
-
101
-
When you edited `interests.json`, you broke some of the unit tests described
97
+
This file describes a GitHub Action workflow which will run unit tests when
98
+
a pull request is open. When you edited `interests.json`, you broke some of the unit tests described
102
99
in `test.js`.
103
100
101
+
> Automated tests are an important part of Continuous Integration, because they ensure that the code that lands on the `main` branch is passing.
102
+
104
103
### Getting tests passing
105
104
106
105
1. run `npm t` locally, this will show you which tests are currently failing.
One shortcoming of our profile page generator is that we rely on someone
128
127
running `npm run generate` locally to ensure that our pie chart is updated.
129
128
130
-
Ben has updated their repository with a workflow called [`update-svg.yaml`](https://github.com/bcoe/bcoe/blob/main/.github/workflows/update-svg.yaml), which automatically pushes
129
+
`bcoe`has updated their repository with a workflow called [`update-svg.yaml`](https://github.com/bcoe/bcoe/blob/main/.github/workflows/update-svg.yaml), which automatically pushes
131
130
an updated version of `interests.svg`, when changes are landed to the `main`
132
131
branch.
133
132
134
133
Use this file as a starting point, and try adding similar functionality to
135
-
your repository.
136
-
137
-
If it's working, any updates to `interests.json` should be reflected in an
134
+
your repository. Once configured, any updates to `interests.json` should be reflected in an
0 commit comments