ci_update_dependencies.yml

name: CI - Update dependencies PR

on:
  workflow_call:
    inputs:
      git_username:
        description: "A git username (used to set the 'user.name' config option)."
        required: true
        type: string
      git_email:
        description: "A git user's email address (used to set the 'user.email' config option)."
        required: true
        type: string
      permanent_dependencies_branch:
        description: "The branch name for the permanent dependency updates branch."
        required: false
        type: string
        default: "ci/dependency-updates"
      default_repo_branch:
        description: "The branch name of the repository's default branch. More specifically, the branch the PR should target."
        required: false
        type: string
        default: main
      pr_body_file:
        description: "Relative path to PR body file from the root of the repository. Example: `'.github/utils/pr_body_update_deps.txt'`."
        required: false
        type: string
        default: ""
      pr_labels:
        description: "A comma separated list of strings of GitHub labels to use for the created PR."
        required: false
        type: string
        default: ""
      extra_to_dos:
        description: "A multi-line string (insert `\\n` to create line breaks) with extra 'to do' checks. Should start with `- [ ] `."
        required: false
        type: string
        default: ""
      update_pre-commit:
        description: "Whether or not to update pre-commit hooks as part of creating the PR."
        required: false
        type: boolean
        default: false
      python_version:
        description: "The Python version to use for the workflow. This is only relevant if `update_pre-commit` is `true`."
        required: false
        type: string
        default: "3.9"
      install_extras:
        description: "Any extras to install from the local repository through 'pip'. Must be encapsulated in square parentheses (`[]`) and be separated by commas (`,`) without any spaces. Example: `'[dev,pre-commit]'`. This is only relevant if `update_pre-commit` is `true`."
        required: false
        type: string
        default: ""
      skip_pre-commit_hooks:
        description: "A comma-separated list of pre-commit hook IDs to skip when running `pre-commit` after updating hooks. This is only relevant if `update_pre-commit` is `true`."
        required: false
        type: string
        default: ""
    secrets:
      PAT:
        description: "A personal access token (PAT) with rights to update the `permanent_dependencies_branch`. This will fallback on `GITHUB_TOKEN`."
        required: false

jobs:
  create-collected-pr:
    name: Single dependabot PR
    runs-on: ubuntu-latest

    steps:
    - name: Checkout ${{ github.repository }}
      uses: actions/checkout@v4
      with:
        ref: ${{ inputs.default_repo_branch }}

    - name: Set up git user info
      run: |
        git config --global user.name "${{ inputs.git_username }}"
        git config --global user.email "${{ inputs.git_email }}"

    - name: Reset to '${{ inputs.permanent_dependencies_branch }}'
      run: |
        git fetch origin ${{ inputs.permanent_dependencies_branch }}:${{ inputs.permanent_dependencies_branch }}
        git reset --hard ${{ inputs.permanent_dependencies_branch }}

    - name: Set up Python ${{ inputs.python_version }}
      if: inputs.update_pre-commit
      uses: actions/setup-python@v5
      with:
        python-version: "${{ inputs.python_version }}"
        allow-prereleases: true

    - name: Install `pre-commit` and dependencies
      if: inputs.update_pre-commit
      run: |
        python -m pip install -U pip
        pip install -U setuptools wheel
        pip install pre-commit
        pip install .${{ inputs.install_extras }}

    - name: Auto-update `pre-commit` hooks
      if: inputs.update_pre-commit
      run: |
        pre-commit autoupdate

        if [ -n "$(git status --porcelain .pre-commit-config.yaml)" ]; then
          # Set environment variable notifying next steps that the hooks changed
          echo "Pre-commit hooks have been updated !"
          echo "UPDATED_PRE_COMMIT_HOOKS=true" >> $GITHUB_ENV
        else
          echo "No pre-commit hooks have been updated."
          echo "UPDATED_PRE_COMMIT_HOOKS=false" >> $GITHUB_ENV
        fi

    - name: Possibly run `pre-commit` with updated hooks
      if: inputs.update_pre-commit
      continue-on-error: true  # Still create the PR if this step fails
      run: |
        if [ "${UPDATED_PRE_COMMIT_HOOKS}" == "true" ]; then
          SKIP=${{ inputs.skip_pre-commit_hooks }} pre-commit run --all-files
        fi

    - name: Possibly commit changes and updates
      if: inputs.update_pre-commit
      run: |
        if [ "${UPDATED_PRE_COMMIT_HOOKS}" == "true" ]; then
          git add -- .
          git commit -m "Update \`pre-commit\` hooks"
        fi

    - name: Set PR body
      run: |
        if [ -z "${{ inputs.pr_body_file }}" ] || [ ! -f "${{ inputs.pr_body_file }}" ]; then
          PR_BODY_FILE=.tmp_pr-body_${{ github.run_id }}_${{ github.run_number }}_${{ github.run_attempt }}.txt
          echo "PR_BODY_FILE=${PR_BODY_FILE}" >> $GITHUB_ENV

          echo -e "### Update dependencies\n\nAutomatically created PR from [\`${{ inputs.permanent_dependencies_branch }}\`](https://github.com/${{ github.repository }}/tree/${{ inputs.permanent_dependencies_branch }}).\n\nThe PR is based on the ['CI - Update dependencies PR' workflow](https://SINTEF.github.io/ci-cd/latest/workflows/ci_update_dependencies/) in [SINTEF/ci-cd](https://github.com/SINTEF/ci-cd).\n\n#### To do\n\n- [ ] Check that the diff is sensible, and that tests and builds pass with the new dependency versions.\n${{ inputs.extra_to_dos }}" > ${PR_BODY_FILE}
          echo "Using default PR body."
          echo "REMOVE_PR_BODY_FILE=true" >> $GITHUB_ENV
        else
          echo "Using found PR body text file at ${{ inputs.pr_body_file }}."
          echo "PR_BODY_FILE=${{ inputs.pr_body_file }}" >> $GITHUB_ENV
          echo "REMOVE_PR_BODY_FILE=false" >> $GITHUB_ENV
        fi

    - name: Fetch PR body
      id: pr_body
      uses: chuhlomin/render-template@v1.10
      with:
        template: ${{ env.PR_BODY_FILE }}

    - name: Remove temporary file
      if: env.REMOVE_PR_BODY_FILE == 'true'
      run: rm -f ${PR_BODY_FILE}

    - name: Create PR
      id: cpr
      uses: peter-evans/create-pull-request@v6
      with:
        token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
        committer: "${{ inputs.git_username }} <${{ inputs.git_email }}>"
        author: "${{ inputs.git_username }} <${{ inputs.git_email }}>"
        branch: ci/update-dependencies
        delete-branch: true
        title: "[Auto-generated] Update dependencies"
        body: ${{ steps.pr_body.outputs.result }}
        labels: "${{ inputs.pr_labels }}"

    - name: Information
      run: 'echo "${{ steps.cpr.outputs.pull-request-operation }} PR #${{ steps.cpr.outputs.pull-request-number }}: ${{ steps.cpr.outputs.pull-request-url }}"'