Create a release based workflow that is built on the foundations of the GitHub flow.

Thanks for opening that pull request 💃

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.

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.
2. Click the Draft a new release button.
3. In the field for Tag version, specify v1.0.0.
4. 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.
5. To the top right of the description text box, click Generate release notes.
6. Review the release notes in the text box and customize the content if desired.
7. 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.
8. Click Save draft, as you will publish this release in the next step.

You can now merge your pull request!

1. In a separate tab, go to the Pull requests page for this repository.
2. Open your Release v1.0 pull request.
3. Click Merge pull request.
4. Wait about 20 seconds then refresh this page (the one you're following instructions from). GitHub Actions will automatically update to the next step.

Get help: Post in our discussion board • Review the GitHub status page

© 2023 GitHub • Code of Conduct • MIT License