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
+52-51
Original file line number
Diff line number
Diff line change
@@ -66,24 +66,24 @@ Before using a release based workflow for a larger release, let's create a tag a
66
66
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
67
67
1. Go to the **Releases** page for this repository.
68
68
-_Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link._
69
-
1. Click **Create a new release**
70
-
1. In the field for _Tag version_, specify a number. In this case, use **v0.9**. Keep the _Target_ as **main**
71
-
1. Give the release a title, like "First beta release". If you'd like, you could also give the release a short description
72
-
1. Select the checkbox next to **Set as a pre-release**, since it is representing a beta version
73
-
1. Click **Publish release**
69
+
1. Click **Create a new release**.
70
+
1. In the field for _Tag version_, specify a number. In this case, use **v0.9**. Keep the _Target_ as **main**.
71
+
1. Give the release a title, like "First beta release". If you'd like, you could also give the release a short description.
72
+
1. Select the checkbox next to **Set as a pre-release**, since it is representing a beta version.
73
+
1. Click **Publish release**.
74
74
75
75
### :keyboard: Activity: Introduce a bug to be fixed later
76
76
77
77
To set the stage for later, let's also add a bug that we'll fix as part of the release workflow in later steps. We've already created a `update-text-colors` branch for you so let's create and merge a pull request with this branch.
78
78
79
-
1. Open a **new pull request** with `base: release-v1.0` and `compare: update-text-colors`
80
-
1. Set the pull request title to `Updated game text style`. You can include a detailed pull request body, an example is below:
79
+
1. Open a **new pull request** with `base: release-v1.0` and `compare: update-text-colors`.
80
+
1. Set the pull request title to "Updated game text style". You can include a detailed pull request body, an example is below:
81
81
```
82
82
## Description:
83
83
- Updated game text color to green
84
84
```
85
-
1. Click `Create pull request`
86
-
1. We'll merge this pull request now. Click `Merge pull request` and delete your branch.
85
+
1. Click **Create pull request**.
86
+
1. We'll merge this pull request now. Click **Merge pull request** and delete your branch.
87
87
1. Wait about 20 seconds then refresh this page for the next step.
88
88
89
89
</details>
@@ -117,15 +117,15 @@ Releases are usually made of many smaller changes. Let's pretend we don't know a
117
117
118
118
### :keyboard: Activity: Update `base.css`
119
119
120
-
1. Create a new branch off of the `main` branch and change the `body` CSS declaration in `base.css` to match what is below. This will set the page background to black
120
+
1. Create a new branch off of the `main` branch and change the `body` CSS declaration in `base.css` to match what is below. This will set the page background to black.
121
121
```
122
122
body {
123
123
background-color: black;
124
124
}
125
125
```
126
-
1. Open a pull request with `release-v1.0` as the `base` branch, and your new branch as the `compare` branch
127
-
1. Fill in the pull request template to describe your changes
128
-
1. Click `Create pull request`
126
+
1. Open a pull request with `release-v1.0` as the `base` branch, and your new branch as the `compare` branch.
127
+
1. Fill in the pull request template to describe your changes.
128
+
1. Click **Create pull request**.
129
129
130
130
### Merge the new feature to the release branch
131
131
Even with releases, the GitHub flow is still an important strategy for working with your team. It's a good idea to use short-lived branches for quick feature additions and bug fixes.
@@ -159,16 +159,16 @@ To expedite the creation of this pull request, I've added a pull request templat
159
159
### :keyboard: Activity: Open a release pull request
160
160
Let's make a new pull request comparing the `release-v1.0` branch to the `main` branch.
161
161
162
-
1. Open a **new pull request** with `base: main` and `compare: release-v1.0`
163
-
1. Ensure the title of your pull request is **Release v1.0**
164
-
1. Include a detailed pull request body, an example is below
162
+
1. Open a **new pull request** with `base: main` and `compare: release-v1.0`.
163
+
1. Ensure the title of your pull request is "Release v1.0".
164
+
1. Include a detailed pull request body, an example is below:
165
165
```
166
166
## Description:
167
167
- Changed page background color to black.
168
168
- Changed game text color to green.
169
169
```
170
-
1. Click `Create pull request`
171
-
1. Wait about 20 seconds then refresh this page for the next step
170
+
1. Click **Create pull request**.
171
+
1. Wait about 20 seconds then refresh this page for the next step.
172
172
173
173
</details>
174
174
@@ -184,22 +184,22 @@ _Thanks for opening that pull request :dancer:_
184
184
### :keyboard: Activity: Generate release notes
185
185
186
186
1. In a separate tab, go to the **Releases** page for this repository.
187
-
- _Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link_
188
-
1. Click the **Draft a new release** button
189
-
1. In the field for _Tag version_, specify `v1.0.0`
190
-
1. To the right of the tag dropdown, click the _Target_ dropddown and select the `release-v1.0` branch
191
-
- _Tip: This is temporary in order to generate release notes based on the changes in this branch_
192
-
1. To the top right of the description text box, click **Generate release notes**
193
-
1. Review the release notes in the text box and customize the content if desired
194
-
1. Set the _Target_ branch back to the `main`, as this is the branch you want to create your tag on once the release branch is merged
195
-
1. Click **Save draft**, as you will publish this release in the next step
187
+
- _Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link._
188
+
1. Click the **Draft a new release** button.
189
+
1. In the field for _Tag version_, specify `v1.0.0`.
190
+
1. To the right of the tag dropdown, click the _Target_ dropddown and select the `release-v1.0` branch.
191
+
- _Tip: This is temporary in order to generate release notes based on the changes in this branch._
192
+
1. To the top right of the description text box, click **Generate release notes**.
193
+
1. Review the release notes in the text box and customize the content if desired.
194
+
1. Set the _Target_ branch back to the `main`, as this is the branch you want to create your tag on once the release branch is merged.
195
+
1. Click **Save draft**, as you will publish this release in the next step.
196
196
197
197
You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request!
198
198
199
199
### :keyboard: Activity: Merge into main
200
200
201
201
1. In a separate tab, go to the **Pull requests** page for this repository.
202
-
1. Open your **Release v1.0** pull request
202
+
1. Open your **Release v1.0** pull request.
203
203
1. Click **Merge pull request**.
204
204
1. Wait about 20 seconds then refresh this page for the next step.
205
205
@@ -236,12 +236,12 @@ Now let's change our recently automated release from _draft_ to _latest release_
236
236
237
237
### :keyboard: Activity: Finalize release
238
238
239
-
1. In a separate tab, go to the **Releases** page for this repository
240
-
- To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link
241
-
1. Click the **Edit** button next to your draft release
242
-
1. Ensure the _Target_ branch is set to `main`
243
-
1. Click **Publish release**
244
-
1. Wait about 20 seconds then refresh this page for the next step
239
+
1. In a separate tab, go to the **Releases** page for this repository.
240
+
- _Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link._
241
+
1. Click the **Edit** button next to your draft release.
242
+
1. Ensure the _Target_ branch is set to `main`.
243
+
1. Click **Publish release**.
244
+
1. Wait about 20 seconds then refresh this page for the next step.
245
245
246
246
</details>
247
247
@@ -269,27 +269,28 @@ We'll submit a hotfix by creating and merging the pull request.
269
269
270
270
### :keyboard: Activity: Create and merge the hotfix pull request
271
271
272
-
1. Open a pull request with `hotfix-v1.0.1` as the `base` branch, and `fix-game-background` as the `compare` branch
273
-
1. Fill in the pull request template to describe your changes. You can set the pull request title to `Hotfix for broken game style`. You can include a detailed pull request body, an example is below:
272
+
1. Open a pull request with `hotfix-v1.0.1` as the `base` branch, and `fix-game-background` as the `compare` branch.
273
+
1. Fill in the pull request template to describe your changes. You can set the pull request title to "Hotfix for broken game style". You can include a detailed pull request body, an example is below:
274
274
```
275
275
## Description:
276
276
- Fixed bug, set game background back to black
277
277
```
278
-
1. Review the changes and click `Create pull request`
279
-
1. We want to merge this into our hotfix branch now so click **Merge pull request**
278
+
1. Review the changes and click **Create pull request**.
279
+
1. We want to merge this into our hotfix branch now so click **Merge pull request**.
280
280
281
281
Now we want these changes merged into `main` as well so let's create and merge a pull request with our hotfix to `main`.
282
282
### :keyboard: Activity: Create the release pull request
283
283
284
-
1. Open a pull request with `main` as the `base` branch, and `hotfix-v1.0.1` as the `compare` branch
285
-
1. Fill in the pull request template to describe your changes, you can set the pull request title to `Hotfix v1.0.1` and you can include a detailed pull request body, an example is below
284
+
1. Open a pull request with `main` as the `base` branch, and `hotfix-v1.0.1` as the `compare` branch.
285
+
1. Ensure the title of your pull request is "Hotfix v1.0.1".
286
+
1. Include a detailed pull request body, an example is below:
286
287
```
287
288
## Description:
288
289
- Fixed bug introduced in last production release - set game background back to black
289
290
```
290
-
1. Review the changes and click `Create pull request`
291
-
1. Click **Merge pull request**
292
-
1. Wait about 20 seconds then refresh this page for the next step
291
+
1. Review the changes and click **Create pull request**.
292
+
1. Click **Merge pull request**.
293
+
1. Wait about 20 seconds then refresh this page for the next step.
293
294
294
295
</details>
295
296
@@ -309,15 +310,15 @@ With descriptive pull requests and auto generated release notes, you don't have
309
310
310
311
### :keyboard: Activity: Complete release
311
312
312
-
1. In a separate tab, go to to the **Releases** page for this repository
313
-
- _Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link_
314
-
1. Click the **Draft a new release** button
315
-
1. Set the _Target_ branch to `main`
313
+
1. In a separate tab, go to to the **Releases** page for this repository.
314
+
- _Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link._
315
+
1. Click the **Draft a new release** button.
316
+
1. Set the _Target_ branch to `main`.
316
317
- _Tip: Practice your semantic version syntax. What should the tag and title for this release be?_
317
-
1. To the top right of the description text box, click **Generate release notes**
318
-
1. Review the release notes in the text box and customize the content if desired
319
-
1. Click **Publish release**
320
-
1. Wait about 20 seconds then refresh this page for the next step
318
+
1. To the top right of the description text box, click **Generate release notes**.
319
+
1. Review the release notes in the text box and customize the content if desired.
320
+
1. Click **Publish release**.
321
+
1. Wait about 20 seconds then refresh this page for the next step.
0 commit comments