From af029d7cd437c45888a5e7881feb54f9ef8334c5 Mon Sep 17 00:00:00 2001 From: fleisch Date: Fri, 28 Oct 2022 14:42:03 +0200 Subject: [PATCH] Better release description --- .github/workflows/distribute.yaml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/distribute.yaml b/.github/workflows/distribute.yaml index 378a4cbf45..57cae1d88b 100644 --- a/.github/workflows/distribute.yaml +++ b/.github/workflows/distribute.yaml @@ -644,7 +644,16 @@ jobs: - uses: ncipollo/release-action@v1 with: artifacts: "sirius_dist/build/tmp/artifacts/*/*" - body: "Prebuilt SIRIUS releases for all supported platforms. [Signed installers](https://github.com/bright-giant/sirius/releases) of this builds provided by [Bright Giant](https://bright-giant.com/) might be available [here](https://github.com/bright-giant/sirius/releases)." + body: | + ### Prebuilt SIRIUS releases for all supported platforms. + Installers provided by [Bright Giant](https://github.com/bright-giant/sirius/releases/) are identical to the ones provided by the [Bökerlab](https://github.com/boecker-lab/sirius/releases) but are digitally signed which eases installation on Windows and MacOS. + + Package names are made up as follows: `---.`. Package types are either generic `.zip` archives or operating system specific installers (e.g. `.pkg` or `.msi`). The flavors describe builds with different features: + * no _Flavor_ suffix represents for the standard SIRIUS package that contains the Graphical User Interface (GUI) and the Command Line Tool (CLI) + * `headless` represents a command line only version that does not contain GUI relevant packages. It is smaller and does not need any GUI libraries installed on the users system (good for servers). + * `service` like standard but additionally contains the experimental _service mode_ of SIRIUS which allows to start SIRIUS as a background service that can be queried form scripting languages or as part of workflows. See the [online documentation](https://boecker-lab.github.io/docs.sirius.github.io/quick-start/#background-service---generic-sirius-api) for details. + + Changelog can be found [here](https://boecker-lab.github.io/docs.sirius.github.io/changelog/). name: "SIRIUS v${{ steps.sirius_version.outputs.value }}" tag: "v${{ steps.sirius_version.outputs.value }}" prerelease: ${{ endsWith(steps.sirius_version.outputs.value, '-SNAPSHOT') }}