name: Release

on:
  push:
    # The workflow triggers only when a tag matching the pattern (e.g., v0.1.0) is pushed.
    tags:
      - "v*.*.*"

jobs:
  create-release:
    name: Create GitHub Release
    runs-on: ubuntu-latest
    # Write permission is required for the action to create a release.
    permissions:
      contents: write 
    
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
      
      - name: Create Release
        uses: softprops/action-gh-release@v2
        with:
          # Release notes are generated automatically based on pull requests merged since the last tag.
          generate_release_notes: true
          
          # NOTE: Build steps can be added prior to this step to compile platform binaries.
          # The resulting artifacts can then be attached to the release using the `files` parameter.