|
| 1 | +# Bellissima release instructions |
| 2 | + |
| 3 | + |
| 4 | +## Build |
| 5 | + |
| 6 | +> _See internal documentation on the build/release workflow._ |
| 7 | +
|
| 8 | + |
| 9 | +## GitHub Release Notes |
| 10 | + |
| 11 | +To generate release notes on GitHub. |
| 12 | + |
| 13 | +1. Go to the [**Releases** area](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases) |
| 14 | +2. Press the [**"Draft a new release"** button](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases/new) |
| 15 | +3. In the combobox for "Choose a tag", expand then select or enter the next version number, e.g. `v14.2.0` |
| 16 | + - If the tag does not already exist, an option labelled "Create new tag: v14.2.0 on publish" will appear, select that |
| 17 | +4. In the combobox for "Target: main", expand then select the release branch for the next version, e.g. `release/14.2` |
| 18 | +5. In the combobox for "Previous tag: auto": |
| 19 | + - If the next release is an RC, then you can leave as `auto` |
| 20 | + - Otherwise, select the previous stable version, e.g. `v14.1.1` |
| 21 | +6. Press the **"Generate release notes"** button, this will populate the main textarea |
| 22 | +7. Check the details, view in the "Preview" tab |
| 23 | +8. What type of release is this? |
| 24 | + - If it's an RC, then check "Set as a pre-release" |
| 25 | + - If it's stable, then check "Set as the latest release" |
| 26 | +9. Once you're happy with the contents and ready to save... |
| 27 | + - If you need more time to review, press the **"Save draft"** button and you can come back to it later |
| 28 | + - If you are ready to make the release notes public, then press **"Publish release"** button! :tada: |
| 29 | + |
| 30 | +> If you're curious about how the content is generated, take a look at the `release.yml` configuration: |
| 31 | +> https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/.github/release.yml |
0 commit comments