Files
Umbraco-CMS/.github/RELEASE_INSTRUCTION.md
2024-11-09 10:10:17 +01:00

1.7 KiB

Bellissima release instructions

Build

See internal documentation on the build/release workflow.

GitHub Release Notes

To generate release notes on GitHub.

  • Go to the Releases area
  • Press the "Draft a new release" button
  • In the combobox for "Choose a tag", expand then select or enter the next version number, e.g. release-14.2.0
    • If the tag does not already exist, an option labelled "Create new tag: release-14.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. release-14.1.1
  • Press the "Generate release notes" button, this will populate the main textarea
  • Change the title to match the version, e.g. 14.2.0
  • 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"
  • 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! 🎉

If you're curious about how the content is generated, take a look at the release.yml configuration: https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/.github/release.yml