Skip to content

Commit 402c32c

Browse files
Update to 6 in STEP and README.md
1 parent 9276124 commit 402c32c

File tree

2 files changed

+34
-24
lines changed

2 files changed

+34
-24
lines changed

.github/steps/-step.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5
1+
6

README.md

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,45 +16,55 @@ _Create a release based workflow that is built on the foundations of the GitHub
1616
</header>
1717

1818
<!--
19-
<<< Author notes: Step 5 >>>
19+
<<< Author notes: Step 6 >>>
2020
Start this step by acknowledging the previous step.
2121
Define terms and link to docs.github.com.
2222
-->
2323

24-
## Step 5: Finalize the release
24+
## Step 6: Commit a hotfix to the release
2525

26-
_Awesome work on the release notes :+1:_
26+
_Almost there :heart:_
2727

28-
### Finalizing releases
28+
Notice that I didn't delete the branch? That's intentional.
2929

30-
It's important to be aware of the information what will be visible in that release. In the pre-release, the version and commit messages are visible.
30+
Sometimes mistakes can happen with releases, and we'll want to be able to correct them on the same branch.
3131

32-
![image](https://user-images.githubusercontent.com/13326548/47883578-bdba7780-ddea-11e8-84b8-563e12f02ca6.png)
32+
Now that your release is finalized, we have a confession to make. Somewhere in our recent update, I made a mistake and introduced a bug. Instead of changing the text colors to green, we changed the whole game background.
3333

34-
### Semantic versioning
34+
_Tip: Sometimes GitHub Pages takes a few minutes to update. Your page might not immediately show the recent updates you've made._
3535

36-
Semantic versioning is a formal convention for specifying compatibility. It uses a three-part version number: **major version**; **minor version**; and **patch**. Version numbers convey meaning about the underlying code and what has been modified. For example, versioning could be handled as follows:
36+
![image](https://user-images.githubusercontent.com/13326548/48045461-487dd800-e145-11e8-843c-b91a82213eb8.png)
3737

38-
| Code status | Stage | Rule | Example version |
39-
| ------------------------------- | ------------- | ---------------------------------------------------------------------- | --------------- |
40-
| First release | New product | Start with 1.0.0 | 1.0.0 |
41-
| Backward compatible fix | Patch release | Increment the third digit | 1.0.1 |
42-
| Backward compatible new feature | Minor release | Increment the middle digit and reset the last digit to zero | 1.1.0 |
43-
| Breaking updates | Major release | Increment the first digit and reset the middle and last digits to zero | 2.0.0 |
38+
"Hotfixes", or a quick fix to address a bug in software, are a normal part of development. Oftentimes you'll see application updates whose only description is "bug fixes".
4439

45-
Check out this article on [Semantic versioning](https://semver.org/) to learn more.
40+
When bugs come up after you release a version, you'll need to address them. We've already created a `hotfix-v1.0.1` and `fix-game-background` branches for you to start.
4641

47-
### Finalize the release
42+
We'll submit a hotfix by creating and merging the pull request.
4843

49-
Now let's change our recently automated release from _draft_ to _latest release_.
44+
### :keyboard: Activity: Create and merge the hotfix pull request
5045

51-
### :keyboard: Activity: Finalize release
46+
1. Open a pull request with `hotfix-v1.0.1` as the `base` branch, and `fix-game-background` as the `compare` branch.
47+
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:
48+
```
49+
## Description:
50+
- Fixed bug, set game background back to black
51+
```
52+
1. Review the changes and click **Create pull request**.
53+
1. We want to merge this into our hotfix branch now so click **Merge pull request**.
5254

53-
1. In a separate tab, go to the **Releases** page for this repository.
54-
- _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._
55-
1. Click the **Edit** button next to your draft release.
56-
1. Ensure the _Target_ branch is set to `main`.
57-
1. Click **Publish release**.
55+
Now we want these changes merged into `main` as well so let's create and merge a pull request with our hotfix to `main`.
56+
57+
### :keyboard: Activity: Create the release pull request
58+
59+
1. Open a pull request with `main` as the `base` branch, and `hotfix-v1.0.1` as the `compare` branch.
60+
1. Ensure the title of your pull request is "Hotfix v1.0.1".
61+
1. Include a detailed pull request body, an example is below:
62+
```
63+
## Description:
64+
- Fixed bug introduced in last production release - set game background back to black
65+
```
66+
1. Review the changes and click **Create pull request**.
67+
1. Click **Merge pull request**.
5868
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
5969

6070
<footer>

0 commit comments

Comments
 (0)