ContextQMD
Back to Sunshine

Create a stable Sunshine release

docs/maintainers/release.md

2025.628.45102.6 KB
Original Source

Create a stable Sunshine release

Pre-releases in Sunshine are created automatically on every push event to the master branch. These are required to be created before making a stable release. Below are the instructions for converting a pre-release to stable.

  1. Wait for the pre-release to be created.

  2. Once the pre-release is created, the copr build will begin in the beta copr repo. Wait for this build to succeed before continuing. You can view the status here

  3. Once the workflow mentioned in step 2 completes, it will update the GitHub release with the RPM files from the copr build.

  4. At this point, the GitHub release can be edited.

    • Add any top-level release notes.
    • Ensure any security fixes are mentioned first with links to the security advisories.
    • Following security advisories, breaking changes should be mentioned. Be sure to mention anything the user may need to do to ensure a smooth upgrade experience.
    • Then highlight any notable new features and/or fixes.
    • Lastly, reduce the automated changelog list. Things like dependency updates and ci updates can mostly be removed.

  5. When saving, uncheck "pre-release" and save the release. This will make the release stable and kick off a series of workflows, including but not limited to the following: