Skip to content

Commit 23bd704

Browse files
Update to 4 in STEP and README.md
1 parent 8a958c9 commit 23bd704

File tree

2 files changed

+22
-23
lines changed

2 files changed

+22
-23
lines changed

.github/steps/-step.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3
1+
4

README.md

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

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

24-
## Step 3: Open a release pull request
24+
## Step 4: Generate release notes and merge
2525

26-
_Nice work adding a new feature :smile:_
26+
_Thanks for opening that pull request :dancer:_
2727

28-
### Release branches and `main`
28+
### Automatically generated release notes
2929

30-
You should open a pull request between your release branch and main as early as possible. It might be open for a long time, and that's okay.
30+
[Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) provide an automated alternative to manually writing release notes for your GitHub releases. With automatically generated release notes, you can quickly generate an overview of the contents of a release. Automatically generated release notes include a list of merged pull requests, a list of contributors to the release, and a link to a full changelog. You can also customize your release notes once they are generated.
3131

32-
In general, the pull request description can include:
32+
### :keyboard: Activity: Generate release notes
3333

34-
- A [reference to an issue](https://docs.github.com/en/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) that the pull request addresses.
35-
- A description of the changes proposed in the pull request.
36-
- [@mentions](https://docs.github.com/en/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) of the person or team responsible for reviewing proposed changes.
34+
1. In a separate tab, go to the **Releases** page for this repository.
35+
- _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._
36+
1. Click the **Draft a new release** button.
37+
1. In the field for _Tag version_, specify `v1.0.0`.
38+
1. To the right of the tag dropdown, click the _Target_ dropddown and select the `release-v1.0` branch.
39+
- _Tip: This is temporary in order to generate release notes based on the changes in this branch._
40+
1. To the top right of the description text box, click **Generate release notes**.
41+
1. Review the release notes in the text box and customize the content if desired.
42+
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.
43+
1. Click **Save draft**, as you will publish this release in the next step.
3744

38-
To expedite the creation of this pull request, I've added a pull request template to the repository. When you create a pull request, default text will automatically be displayed. This should help you identify and fill out all the necessary information. If you don't want to use the template content, just remove the text from the pull request and replace it with your pull request message.
45+
You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request!
3946

40-
### :keyboard: Activity: Open a release pull request
47+
### :keyboard: Activity: Merge into main
4148

42-
Let's make a new pull request comparing the `release-v1.0` branch to the `main` branch.
43-
44-
1. Open a **new pull request** with `base: main` and `compare: release-v1.0`.
45-
1. Ensure the title of your pull request is "Release v1.0".
46-
1. Include a detailed pull request body, an example is below:
47-
```
48-
## Description:
49-
- Changed page background color to black.
50-
- Changed game text color to green.
51-
```
52-
1. Click **Create pull request**.
49+
1. In a separate tab, go to the **Pull requests** page for this repository.
50+
1. Open your **Release v1.0** pull request.
51+
1. Click **Merge pull request**.
5352
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.
5453

5554
<footer>

0 commit comments

Comments
 (0)