plantuml/docs/releasing.md

1.6 KiB

GitHub Releases

Creating a new release in GitHub is done as part of the CI workflow but only when the workflow run is for a new git tag beginning with a v.

Tags cannot be part of a pull request, so you need to push directly to the plantuml repo, e.g.

git tag -a v1.2021.1 -m "version 1.2021.1"
git push origin v1.2021.1

The release will only happen if the username making the push is matched in the CI Configure job step.

Docker Images

Docker images are released as Github Packages and to Docker hub.

Artifact Signing

The CI workflow will sign artifacts if the ARTIFACT_SIGNING_KEY GitHub secret is present. This should be a private GPG key as described here. The passphrase is stored in the ARTIFACT_SIGNING_PASSPHRASE secret.

Currently, the signature files are only published as part of the snapshot releases. In future, they will be part of the versioned releases as well.

Releases Elsewhere

PlantUML is released to other places, currently that happens outside of GitHub and is not documented here.