Skip to content

Commit dc31a02

Browse files
committed
docs: flesh out lab
1 parent c5da681 commit dc31a02

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Exploring CI/CD with a Profile README.md
22

33
[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,
55
the `README.md` in this repository will be displayed on your profile page.
66

77
Here's [an example](https://github.com/bcoe/bcoe).
88

9-
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
1010
[GitHub Actions](https://docs.github.com/en/actions) and your Profile README.md.
1111

1212
## The Workshop
@@ -38,10 +38,9 @@ account with the same name as your username:
3838

3939
### Personalize your profile page
4040

41-
Let's personalize bio that you used as a template:
41+
Let's personalize your biography:
4242

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)_).
4544
2. Create a branch to commit your changes on,
4645
`cd [my-user-name]`, `git checkout -b personalize`.
4746
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:
5958

6059
1. `git commit -a -m 'docs: update bio to reflect myself'`.
6160
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**.
6362

6463
### Look closely at your pull request
6564

@@ -95,12 +94,12 @@ When you created your repository, it included the file `.github/workflows/ci.yam
9594
- run: npm test
9695
```
9796
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
10299
in `test.js`.
103100

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+
104103
### Getting tests passing
105104

106105
1. run `npm t` locally, this will show you which tests are currently failing.
@@ -127,24 +126,21 @@ GitHub (`github.com/[your-user-name]`).
127126
One shortcoming of our profile page generator is that we rely on someone
128127
running `npm run generate` locally to ensure that our pie chart is updated.
129128

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
131130
an updated version of `interests.svg`, when changes are landed to the `main`
132131
branch.
133132

134133
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
138135
automated pull request, [like this](https://github.com/bcoe/bcoe/pull/4).
139136

140-
## You're done!
137+
> Pushing code automatically to a branch like this is analogous to Continuous Deployment.
141138

142-
That's the end of the workshop 🥳, to recap:
139+
## You're done!
143140

144-
* `ci.yaml`: demonstrates the concept of continuous integration.
145-
* `update-svg.yaml`: demonstrates the concept of continuous deployment.
141+
That's the end of the workshop 🥳
146142

147-
I encourage you to continue personalizing your `README.md`, and to keep
143+
But, I encourage you to continue personalizing your `README.md`, and to keep
148144
experimenting with GitHub Actions.
149145

150146
## License

0 commit comments

Comments
 (0)