Skip to content

Commit

Permalink
Update to 7 in STEP and README.md
Browse files Browse the repository at this point in the history
github-actions committed Jun 19, 2023
1 parent e657dd1 commit acd9eb2
Showing 2 changed files with 17 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .github/steps/-step.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6
7
54 changes: 16 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -16,55 +16,33 @@ _Create a release based workflow that is built on the foundations of the GitHub
</header>

<!--
<<< Author notes: Step 6 >>>
<<< Author notes: Step 7 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 6: Commit a hotfix to the release
## Step 7: Create release v1.0.1

_Almost there :heart:_
_One last step to go!_

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

Sometimes mistakes can happen with releases, and we'll want to be able to correct them on the same branch.
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.

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

_Tip: Sometimes GitHub Pages takes a few minutes to update. Your page might not immediately show the recent updates you've made._
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.

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

"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".

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.

We'll submit a hotfix by creating and merging the pull request.

### :keyboard: Activity: Create and merge the hotfix pull request

1. Open a pull request with `hotfix-v1.0.1` as the `base` branch, and `fix-game-background` as the `compare` branch.
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:
```
## Description:
- Fixed bug, set game background back to black
```
1. Review the changes and click **Create pull request**.
1. We want to merge this into our hotfix branch now so click **Merge pull request**.

Now we want these changes merged into `main` as well so let's create and merge a pull request with our hotfix to `main`.

### :keyboard: Activity: Create the release pull request

1. Open a pull request with `main` as the `base` branch, and `hotfix-v1.0.1` as the `compare` branch.
1. Ensure the title of your pull request is "Hotfix v1.0.1".
1. Include a detailed pull request body, an example is below:
```
## Description:
- Fixed bug introduced in last production release - set game background back to black
```
1. Review the changes and click **Create pull request**.
1. Click **Merge pull request**.
1. In a separate tab, go to to the **Releases** page for this repository.
- _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._
1. Click the **Draft a new release** button.
1. Set the _Target_ branch to `main`.
- _Tip: Practice your semantic version syntax. What should the tag and title for this release be?_
1. To the top right of the description text box, click **Generate release notes**.
1. Review the release notes in the text box and customize the content if desired.
1. Click **Publish release**.
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.

<footer>

0 comments on commit acd9eb2

Please sign in to comment.