Skip to content

Commit

Permalink
Update to 4 in STEP and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Dec 15, 2023
1 parent 6ab1ff7 commit 05503c2
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/steps/-step.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3
4
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,39 @@ _Create a release based workflow that is built on the foundations of the GitHub
</header>

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

## Step 3: Open a release pull request
## Step 4: Generate release notes and merge

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

### Release branches and `main`
### Automatically generated release notes

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

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

- 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.
- A description of the changes proposed in the pull request.
- [@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.
1. In a separate tab, go 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. In the field for _Tag version_, specify `v1.0.0`.
1. To the right of the tag dropdown, click the _Target_ dropddown and select the `release-v1.0` branch.
- _Tip: This is temporary in order to generate release notes based on the changes in this branch._
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. 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.
1. Click **Save draft**, as you will publish this release in the next step.

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.
You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request!

### :keyboard: Activity: Open a release pull request
### :keyboard: Activity: Merge into main

Let's make a new pull request comparing the `release-v1.0` branch to the `main` branch.

1. Open a **new pull request** with `base: main` and `compare: release-v1.0`.
1. Ensure the title of your pull request is "Release v1.0".
1. Include a detailed pull request body, an example is below:
```
## Description:
- Changed page background color to black.
- Changed game text color to green.
```
1. Click **Create pull request**.
1. In a separate tab, go to the **Pull requests** page for this repository.
1. Open your **Release v1.0** pull request.
1. Click **Merge pull request**.
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>
Expand Down

0 comments on commit 05503c2

Please sign in to comment.