action.yml

name: Open downstream PR if necessary
description: This action opens a PR against downstream repositories to update a library dependency.
inputs:
  repository:
    required: true
    description: The downstream repository that consumes the library dependency.
  token:
    required: true
    description: Github PAT used to open PRs. This token must have write access against the repository.
  update-command:
    required: true
    description: The command run from the downstream repo that is used to update the library dependency.
  working-directory:
    required: false
    default: ""
    description: The relative directory in the downstream repo where all commands will run.
  relevance-filter:
    required: false
    default: "- '**'"
    description: A path filter used to determine if any relevant files where changed as a result of the `update-command`. By default, all changes are considered relevant.
  reviewers:
    required: false
    description: A comma or newline-separated list of reviewers (GitHub usernames) to request a review from.
  team-reviewers:
    required: false
    description: A comma or newline-separated list of GitHub teams to request a review from.
  title:
    required: false
    description: The title of the pull request.
    default: "[bot] Bump ${{github.event.repository.name}}"
  committer:
    required: false
    description: The committer name and email address in the format Display Name <email@address.com>. Defaults to the GitHub Actions bot user.
    default: "GitHub <noreply@github.com>"
  author:
    required: false
    description: The author name and email address in the format Display Name <email@address.com>. Defaults to the user who triggered the workflow run.
    default: "${{github.actor}} <${{github.actor}}@users.noreply.github.com>"
  commit-message:
    required: false
    description: The message to use when committing changes.
    default: "[bot] Bump ${{github.event.repository.name}}"
  labels:
    required: false
    description: A comma or newline-separated list of labels.
    default: bot
  branch:
    required: false
    description: The pull request branch name.
    default: bump-${{github.repository}}/patch
  auto-merge:
    required: false
    description: Whether or not to enable "Auto-merge" on the pull request.
    default: "false"

outputs:
  pull-request-number:
    description: "The pull request number"
    value: ${{steps.create-pr.outputs.pull-request-number}}
  pull-request-url:
    description: "The URL of the pull request."
    value: ${{steps.create-pr.outputs.pull-request-url}}
  pull-request-operation:
    description: "The pull request operation performed by the action, `created`, `updated` or `closed`."
    value: ${{steps.create-pr.outputs.pull-request-description}}
  pull-request-head-sha:
    description: "The commit SHA of the pull request branch."
    value: ${{steps.create-pr.outputs.pull-request-head-sha}}

runs:
  using: composite
  steps:
    - name: Checkout ${{inputs.repository}}
      uses: actions/checkout@v4
      with:
        repository: ${{inputs.repository}}
        token: ${{inputs.token}}
        path: ${{inputs.repository}}

    - name: Set working directory
      shell: bash
      id: working-dir
      run: |
        if [ -z "${{inputs.working-directory}}" ]
        then
          echo "working_dir=${{inputs.repository}}" >> $GITHUB_ENV
        else
          echo "working_dir=${{inputs.repository}}/${{inputs.working-directory}}" >> $GITHUB_ENV
        fi

    - uses: actions/setup-go@v5
      with:
        go-version-file: ${{ env.working_dir }}/go.mod
        cache: true
        cache-dependency-path: ${{ env.working_dir }}/go.sum

    - name: Setup git
      shell: bash
      run: |
        git config --global url."https://${{inputs.token}}@github.com/".insteadOf https://github.com/

    - name: Run update command
      shell: bash
      working-directory: ${{ env.working_dir }}
      run: ${{inputs.update-command}}

    # If the only files that changed are go.mod, go.sum, and vendor/modules.txt, then it's not worth a PR.
    - name: Check if relevant files were changed
      uses: dorny/paths-filter@v3.0.2
      id: changes
      with:
        working-directory: ${{ env.working_dir }}
        base: HEAD
        filters: |
          relevant:
            ${{inputs.relevance-filter}}

    - name: Construct PR body
      shell: bash
      run: |
        cat << "EOT" >> /tmp/pr_body.txt
        ### Summary
        This PR bumps [${{github.event.repository.name}}](https://github.com/${{github.repository}}) to pick up the most recent changes.

        The following commands were run to generate this PR:
        ```sh
        ${{inputs.update-command}}
        ```
        EOT

        if [ "${{inputs.auto-merge}}" == "true" ]
        then
          echo "---" >> /tmp/pr_body.txt
          echo "### Auto-merge enabled" >> /tmp/pr_body.txt
          echo "This pull request will squash and merge automatically when all requirements are met." >> /tmp/pr_body.txt
          echo "" >> /tmp/pr_body.txt
        fi

        echo "---" >> /tmp/pr_body.txt
        echo "This PR was created by [${{github.workflow}}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) using [launchdarkly-labs/pr-downstream](https://github.com/launchdarkly-labs/pr-downstream)." >> /tmp/pr_body.txt

        echo "pr_body<<EOF" >> $GITHUB_ENV
        cat /tmp/pr_body.txt >> $GITHUB_ENV
        echo "EOF" >> $GITHUB_ENV

    - name: Create pull request
      if: steps.changes.outputs.relevant == 'true'
      uses: peter-evans/create-pull-request@v6.0.2
      id: create-pr
      with:
        branch: ${{inputs.branch}}
        path: ${{inputs.repository}}
        reviewers: ${{inputs.reviewers}}
        team-reviewers: ${{inputs.team-reviewers}}
        delete-branch: true
        commit-message: ${{inputs.commit-message}}
        committer: ${{inputs.committer}}
        author: ${{inputs.author}}
        title: ${{inputs.title}}
        body: ${{env.pr_body}}
        labels: ${{inputs.labels}}
        token: ${{inputs.token}}

    - name: Check outputs
      shell: bash
      if: ${{ steps.create-pr.outputs.pull-request-url }}
      run: |
        echo "Successfully opened a PR: ${{ steps.create-pr.outputs.pull-request-url }}"

    - name: Enable auto-merge
      if: steps.changes.outputs.relevant == 'true' && inputs.auto-merge == 'true'
      uses: peter-evans/enable-pull-request-automerge@v3.0.0
      with:
        repository: ${{inputs.repository}}
        token: ${{inputs.token}}
        pull-request-number: ${{ steps.create-pr.outputs.pull-request-number }}
        merge-method: squash