release-notes-generator.yml

name: Create Sui Release with Release Notes
run-name: Generate Release Notes for ${{ inputs.release_tag }}

concurrency: ${{ github.workflow }}-${{ inputs.release_tag }}

on:
  workflow_dispatch:
    inputs:
      release_tag:
        description: 'Sui Release Tag'
        type: string
        required: true
      previous_branch:
        description: 'Previous Release Branch (Ex: releases/sui-vX.XX.X-release)'
        type: string
        required: true
      current_branch:
        description: 'Current Release Branch (Ex: releases/sui-vX.XX.X-release)'
        type: string
        required: true

env:
  RELEASE_NOTES_FILE: "./release_notes.txt"

jobs:
  get-release-notes:
    name: Get Release Notes for ${{ inputs.release_tag }} release
    runs-on: ubuntu-latest

    steps:
      - name: Get commits for branches
        shell: bash
        working-directory: ./
        run: |
          echo "previous_commit=$(curl https://api.github.com/repos/MystenLabs/sui/commits/${{ inputs.previous_branch }} | jq .sha)" >> $GITHUB_ENV
          echo "current_commit=$(curl https://api.github.com/repos/MystenLabs/sui/commits/${{ inputs.current_branch }} | jq .sha)" >> $GITHUB_ENV

      - name: Checkout main
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # Pin v4.1.1
        with:
          fetch-depth: 0
          ref: main
    
      - name: Setup Python
        uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # pin@v5.0.0
        with:
          python-version: 3.10.10       

      - name: Generate Release Notes
        shell: bash
        working-directory: ./
        run: |
          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} python ./scripts/release_notes.py generate ${{ env.previous_commit }} ${{ env.current_commit }} | tee -a ${{ env.RELEASE_NOTES_FILE }}
          echo "---" >> ${{ env.RELEASE_NOTES_FILE }}
          echo "#### Full Log: https://github.com/MystenLabs/sui/commits/${{ inputs.release_tag }}" >> ${{ env.RELEASE_NOTES_FILE }}

          if [[ ${{ inputs.release_tag }} == devnet* ]]; then
            echo "pre_release=true" >> $GITHUB_ENV
          else
            echo "pre_release=false" >> $GITHUB_ENV
          fi

      - name: Create Release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.SUI_CREATE_RELEASE }}
        with:
          tag_name: ${{ inputs.release_tag }}
          release_name: ${{ inputs.release_tag }}
          body_path: ${{ env.RELEASE_NOTES_FILE }}
          draft: false
          prerelease: ${{ env.pre_release }}