Skip to content

Commit 8786a74

Browse files
author
github-actions
committed
Update to 7 in STEP and README.md
1 parent 1fc5386 commit 8786a74

File tree

2 files changed

+17
-39
lines changed

2 files changed

+17
-39
lines changed

.github/steps/-step.txt

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

README.md

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

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

24-
## Step 6: Commit a hotfix to the release
24+
## Step 7: Create release v1.0.1
2525

26-
_Almost there :heart:_
26+
_One last step to go!_
2727

28-
Notice that I didn't delete the branch? That's intentional.
28+
### A final release
2929

30-
Sometimes mistakes can happen with releases, and we'll want to be able to correct them on the same branch.
30+
You updated the source code, but users can't readily access your most recent changes. Prepare a new release, and distribute that release to the necessary channels.
3131

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.
32+
### Create release v1.0.1
3333

34-
_Tip: Sometimes GitHub Pages takes a few minutes to update. Your page might not immediately show the recent updates you've made._
34+
With descriptive pull requests and auto generated release notes, you don't have to spend a lot of time working on your release draft. Follow the steps below to create your new release, generate the release notes, and publish.
3535

36-
![image](https://user-images.githubusercontent.com/13326548/48045461-487dd800-e145-11e8-843c-b91a82213eb8.png)
36+
### :keyboard: Activity: Complete release
3737

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".
39-
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.
41-
42-
We'll submit a hotfix by creating and merging the pull request.
43-
44-
### :keyboard: Activity: Create and merge the hotfix pull request
45-
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**.
54-
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**.
38+
1. In a separate tab, go to to the **Releases** page for this repository.
39+
- _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._
40+
1. Click the **Draft a new release** button.
41+
1. Set the _Target_ branch to `main`.
42+
- _Tip: Practice your semantic version syntax. What should the tag and title for this release be?_
43+
1. To the top right of the description text box, click **Generate release notes**.
44+
1. Review the release notes in the text box and customize the content if desired.
45+
1. Click **Publish release**.
6846
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.
6947

7048
<footer>

0 commit comments

Comments
 (0)