search

jlean / release-based-workflow

https://lab.github.com/githubtraining/create-a-release-based-workflow
MIT License
0 stars 0 forks source link

Release v1.0 #6

Closed jlean closed 3 years ago

jlean commented 3 years ago

body of my pull request

github-learning-lab[bot] commented 3 years ago

Release branches are long lived, and we opened a pull request for another feature change. This will give our release a more detailed history. We changed the default text to green instead of white.

Several changes might be included in release branches. This is a common practice, and allows you to continue to ship code quickly without blockers.

Head over to the next pull request for your next steps.

github-learning-lab[bot] commented 3 years ago

Automating releases

Now that our release branch is ready to be merged, we have two more steps to take.

First, let's make sure that we're set up to document the version changes for the users.

Step 8: Install and configure a GitHub app

We'll be using the Release Drafter GitHub app to draft our release notes as pull requests are merged.

The Release Drafter updates releases, so it requires write access to this repository. When you install the app, you don't need to add it to your entire GitHub account. Only install it on this repository. Release Drafter doesn't work just out of the box. If you use this in the future, you'll need to add .github/release-drafter.yml to your repository. We'll take care of adding this in a separate PR.

:keyboard: Activity: Install the Release Drafter GitHub app

  1. Install the Release Drafter GitHub app to this repository only.
  2. Open a new pull request with base: release-v1.0 and compare: config-release-drafter. This will add the configuration file for Release Drafter to this repository.

Note: For privacy reasons, we can't see what other apps have access to this repository, so we'll take your word for it.

I'll respond in your new pull request.

Sometimes I respond too fast for the page to update! If you don't see a response from me, wait a few seconds and refresh the page for your next steps.

github-learning-lab[bot] commented 3 years ago

Thanks for the merge. Notice that I didn't delete the branch? That's intentional.

Sometimes mistakes can happen with releases, and we'll want to be able to correct them on the same branch. Before we worry about any of that, let's finalize our first release!

Look for instructions in this issue.