release.yml

# GitHub Actions Workflow created for handling the release process based on the draft release prepared
# with the Build workflow. Running the publishPlugin task requires the PUBLISH_TOKEN secret provided.

name: Release
on:
  release:
    types: [prereleased, released]

permissions:
  contents: write

jobs:

  # Prepare and publish the plugin to the Marketplace repository
  release:
    name: Publish Plugin
    runs-on: ubuntu-latest
    steps:

      # Setup Java 11 environment for the next steps
      - name: Setup Java
        uses: actions/setup-java@v4.7.1
        with:
          java-version: 17
          distribution: 'zulu'

      # Check out current repository
      - name: Fetch Sources
        uses: actions/checkout@v4
        with:
          submodules: true
          ref: ${{ github.event.release.tag_name }}

      # Publish the plugin to the Marketplace
      - name: Publish Plugin
        env:
          PUBLISH_TOKEN: ${{ vars.PUBLISH_TOKEN }}
          PRE_RELEASE: ${{ github.event.release.prerelease }}
        run: ./gradlew publishPlugin

      # List all files in the project (excluding node_modules)
      - name: List Project Files
        run: find . -type f -not -path "*/node_modules/*" | sort

  # Patch changelog, commit and push to the current repository
  changelog:
    name: Update Changelog
    needs: release
    runs-on: ubuntu-latest
    if: ${{ github.event.release.prerelease }}
    steps:

      # Setup Java 11 environment for the next steps
      - name: Setup Java
        uses: actions/setup-java@v4.7.1
        with:
          java-version: 17
          distribution: 'zulu'

      # Check out current repository
      - name: Fetch Sources
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.release.tag_name }}

      # Update Unreleased section with the current version
      - name: Patch Changelog
        run: ./gradlew patchChangelog

      # Commit patched Changelog
      - name: Commit files
        run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git commit -m "Update changelog" -a
      # Push changes
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          branch: main
          github_token: ${{ secrets.GITHUB_TOKEN }}