Skip to content

Commit

Permalink
Updated RELEASE_INSTRUCTION.md
Browse files Browse the repository at this point in the history
Markdown formatting corrections.
  • Loading branch information
leekelleher committed Aug 21, 2024
1 parent 5f4fe4c commit 771523b
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions .github/RELEASE_INSTRUCTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@

To generate release notes on GitHub.

1. Go to the [**Releases** area](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases)
2. Press the [**"Draft a new release"** button](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases/new)
3. In the combobox for "Choose a tag", expand then select or enter the next version number, e.g. `v14.2.0`
- If the tag does not already exist, an option labelled "Create new tag: v14.2.0 on publish" will appear, select that
4. In the combobox for "Target: main", expand then select the release branch for the next version, e.g. `release/14.2`
5. In the combobox for "Previous tag: auto":
- Go to the [**Releases** area](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases)
- Press the [**"Draft a new release"** button](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases/new)
- In the combobox for "Choose a tag", expand then select or enter the next version number, e.g. `v14.2.0`
- If the tag does not already exist, an option labelled "Create new tag: v14.2.0 on publish" will appear, select that option
- In the combobox for "Target: main", expand then select the release branch for the next version, e.g. `release/14.2`
- In the combobox for "Previous tag: auto":
- If the next release is an RC, then you can leave as `auto`
- Otherwise, select the previous stable version, e.g. `v14.1.1`
6. Press the **"Generate release notes"** button, this will populate the main textarea
7. Check the details, view in the "Preview" tab
8. What type of release is this?
- Otherwise, select the previous stable version, e.g. `v14.1.1`
- Press the **"Generate release notes"** button, this will populate the main textarea
- Check the details, view in the "Preview" tab
- What type of release is this?
- If it's an RC, then check "Set as a pre-release"
- If it's stable, then check "Set as the latest release"
9. Once you're happy with the contents and ready to save...
- If you need more time to review, press the **"Save draft"** button and you can come back to it later
- If it's stable, then check "Set as the latest release"
- Once you're happy with the contents and ready to save...
- If you need more time to review, press the **"Save draft"** button and you can come back to it later
- If you are ready to make the release notes public, then press **"Publish release"** button! :tada:

> If you're curious about how the content is generated, take a look at the `release.yml` configuration:
Expand Down

0 comments on commit 771523b

Please sign in to comment.