check-changeset.yml

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Check Changeset

on:
  pull_request:
    branches:
      - main

env:
  GITHUB_PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
  GITHUB_PULL_REQUEST_BASE_SHA: ${{ github.event.pull_request.base.sha }}

jobs:
  check_changeset:
    name: Check changeset vs changed files
    runs-on: ubuntu-latest

    permissions:
      pull-requests: write

    steps:
    - name: Checkout Repo
      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # ratchet:actions/checkout@v7
      with:
        # This makes Actions fetch all Git history so check_changeset script can diff properly.
        fetch-depth: 0
        persist-credentials: false
    - name: Set up Node (24)
      uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # ratchet:actions/setup-node@v7
      with:
        node-version: 24.19.0
    - name: Yarn install
      run: yarn
    - name: Run changeset script
      # pull main so changeset can diff against it
      run: |
        git pull -f --no-rebase origin main:main
        yarn ts-node-script scripts/ci/check_changeset.ts
      id: check-changeset
    - name: Print changeset checker output
      run: |
        cat << 'eof_delimiter_that_will_never_occur_in_CHANGESET_ERROR_MESSAGE'
        ${STEPS_CHECK_CHANGESET_OUTPUTS_CHANGESET_ERROR_MESSAGE}
        eof_delimiter_that_will_never_occur_in_CHANGESET_ERROR_MESSAGE
      env:
        STEPS_CHECK_CHANGESET_OUTPUTS_CHANGESET_ERROR_MESSAGE: ${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
    - name: Print blocking failure status
      run: echo "${STEPS_CHECK_CHANGESET_OUTPUTS_BLOCKING_FAILURE}"
      env:
        STEPS_CHECK_CHANGESET_OUTPUTS_BLOCKING_FAILURE: ${{steps.check-changeset.outputs.BLOCKING_FAILURE}}
    - name: Find Comment
      # This commit represents v3.1.0
      uses: peter-evans/find-comment@a4ef349b8c29f841860ce94ed82b20f0a39b6961
      id: fc
      with:
        issue-number: ${{github.event.number}}
        body-includes: Changeset File Check
    - name: Create comment (missing packages)
      if: ${{!steps.fc.outputs.comment-id && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
      # This commit represents v4.0.0
      uses: peter-evans/create-or-update-comment@e2426b4b1346fd5e8c731c0bbe368063ea0286ac
      with:
        issue-number: ${{github.event.number}}
        body: |
          ### Changeset File Check :warning:
          ${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
    - name: Update comment (missing packages)
      if: ${{steps.fc.outputs.comment-id && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
      # This commit represents v4.0.0
      uses: peter-evans/create-or-update-comment@e2426b4b1346fd5e8c731c0bbe368063ea0286ac
      with:
        comment-id: ${{steps.fc.outputs.comment-id}}
        edit-mode: replace
        body: |
          ### Changeset File Check :warning:
          ${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
    - name: Update comment (no missing packages)
      if: ${{steps.fc.outputs.comment-id && !steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
      # This commit represents v4.0.0
      uses: peter-evans/create-or-update-comment@e2426b4b1346fd5e8c731c0bbe368063ea0286ac
      with:
        comment-id: ${{steps.fc.outputs.comment-id}}
        edit-mode: replace
        body: |
          ### Changeset File Check :white_check_mark:
          - No modified packages are missing from the changeset file.
          - No changeset formatting errors detected.
    # Don't want it to throw before editing the comment.
    - name: Fail if checker script logged a blocking failure
      if: ${{steps.check-changeset.outputs.BLOCKING_FAILURE == 'true'}}
      run: exit 1