Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rmallorybpc authored Jun 23, 2022
1 parent 1136442 commit 314c739
Showing 1 changed file with 14 additions and 17 deletions.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,41 +136,38 @@ To expedite the creation of this pull request, I've added a pull request templat
### :keyboard: Activity: Open a release pull request
Let's make a new pull request comparing the `release-v1.0` branch to the `main` branch.

1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
1. Open a **new pull request** with `base: main` and `compare: release-v1.0`.
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab
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.
1. Include a detailed pull request body, an example is below
```
## Description:
- Changed page background color to black
- Changed game text color to green
- Changed page background color to black.
- Changed game text color to green.
```
1. Wait about 20 seconds then refresh this page for the next step.
1. Wait about 20 seconds then refresh this page for the next step
</details>
<!--Step 4-->
<details id=4>
<summary><h2>Step 4: Generate release notes and merge</h2></summary>
_Nicely done opening a release pull request :partying_face:_
### Automatically generated release notes
[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.
### :keyboard: Activity: Generate release notes
1. In a separate tab, go to the **Releases** page for this repository.
- 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.
- _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.
- 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**.
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**
You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request!
Expand Down

0 comments on commit 314c739

Please sign in to comment.