update_copyright.yml

# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

name: update copyright year

on:
  workflow_dispatch:
  schedule:
    - cron: '25 4 1 1 *' # Every Jan 1st @ 04:25 UTC

jobs:
  update-copyright:
    if: github.repository_owner == 'cylc'
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:

      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Configure git
        uses: cylc/release-actions/configure-git@v1

      - name: Checkout PR branch
        uses: cylc/release-actions/checkout-copyright-branch@v1

      - name: Update copyright year
        env:
          README_FILE: 'README.md'
        run: |
          pattern="(<span actions:bind='current-year'>).*(<\/span>)"
          sed -i -E "s/${pattern}/\1${YEAR}\2/" "$README_FILE"

      - name: Commit & push
        run : |
          git commit -a -m "Update copyright year" -m "Workflow: ${{ github.workflow }}, run: ${{ github.run_number }}"
          git push origin "$BRANCH_NAME"

      - name: Create pull request
        uses: cylc/release-actions/create-pr@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          head: ${{ env.BRANCH_NAME }}
          title: 'Auto PR: update copyright year'
          body: 'Happy new year!'