release-create-gh-release.yml

name: Create GitHub release

on:
  push:
    tags:
      - v*

jobs:
  create_release:
    runs-on: ubuntu-24.04
    permissions:
      contents: write # create the GH release
    steps:
      - name: Set env
        run: |
          echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
      - name: Create release
        uses: ncipollo/release-action@v1
        with:
          body: |
            **Adapt this one liner summary**
            ⚡ This new version improves ... ⚡

            _If appropriate, briefly explain the contents of the new version._

            **Update the milestone URL**
            List of issues: [milestone ${{ env.VERSION }}](https://github.com/process-analytics/bpmn-visualization-addons/milestone/x?closed=1)

            ## Breaking changes

            **TODO: keep if relevant and follow the guidelines below**

              - explain why it is introduced
              - explain the impact (use case, usage, impact a lot of user or only few, ....)
              - add references to issue or pull request to help users to understand the breaking change

            ### Removal of deprecated API

            **TODO: keep if relevant and follow the guidelines below**

              - list API
              - add reference to the version and release notes where it was announced as "deprecated"

            ## Deprecated APIs

            **TODO: keep if relevant and follow the guidelines below**

              - list the APIs
              - explain why they are deprecated
              - provide the new API to use instead. If none exist, mention it
              - explain in which version it will be removed. We usually keep 3 minor versions prior removal.
              - ensure that an issue exists to track the removal (one by version is OK) and it is attached to a milestone related to the version

            ## Highlights
            _Note_: use [release 0.2.0](https://github.com/process-analytics/bpmn-visualization-addons/releases/tag/v0.2.0) and [release 0.6.0](https://github.com/process-analytics/bpmn-visualization-addons/releases/tag/v0.6.0)  as examples

            **Add screenshots, animations or videos to make your description more user-friendly!**

            ### Minimal version of `bpmn-visualization`
            _Note_: add this paragraph if the version changed

            You must now use `bpmn-visualization` **0.xx.0** or higher with `bpmn-visualization-addons`. The previous version required `bpmn-visualization` _0.yy.0_ or higher.

            ℹ️ For more details, see #<PR_NUMBER>.

            ### Other changes.... adapt and create more paragraphs
          draft: true
          generateReleaseNotes: true
          name: ${{ env.VERSION }}
          token: ${{ secrets.GH_RELEASE_TOKEN }}