Bump copyright year in LICENSE file

[DimitriPapadopoulos]

This should be done every year. I wonder whether an automated process running in CI could create a PR automatically. Perhaps a workflow triggered by schedule?

TODO:

• Add unit tests and/or doctests in docstrings
• Add docstrings and API docs for any new/modified user-facing classes and functions
• New/modified features documented in docs/user-guide/*.rst
• Changes documented as a new file in changes/
• GitHub Actions have all passed
• Test coverage is 100% (Codecov passes)

[DimitriPapadopoulos]

ChatGPT suggests a .github/workflows/update-copyright.yml: workflow:

name: Update Copyright Year

on:
  schedule:
    - cron: '0 0 1 1 *'  # Runs annually on Jan 1st at 00:00 UTC
  workflow_dispatch:  # Optional: allow manual triggering

jobs:
  bump-year:
    runs-on: ubuntu-latest

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

      - name: Set up Git
        run: |
          git config --global user.name "github-actions[bot]"
          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"

      - name: Update year in LICENSE.txt file
        run: |
          CURRENT_YEAR=$(date +'%Y')
          sed -i "s/[0-9]\{4\}\(-[0-9]\{4\}\)\?\(.*\)/2019-$CURRENT_YEAR\2/" LICENSE.txt  # Adjust pattern to your file
          
      - name: Check if changes occurred
        run: |
          git diff --exit-code || echo "Changes detected."

      - name: Commit changes
        run: |
          git checkout -b update-copyright-$CURRENT_YEAR
          git add LICENSE
          git commit -m "chore: update copyright year to $CURRENT_YEAR"

      - name: Push branch
        run: git push origin update-copyright-$CURRENT_YEAR

      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v6
        with:
          title: "chore: update copyright year"
          body: "Automatically updated to reflect the new year."
          base: main
          branch: update-copyright-${{ steps.bump-year.outputs.year }}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.67%. Comparing base (9dc744d) to head (a7418f2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3286      +/-   ##
==========================================
+ Coverage   59.16%   59.67%   +0.50%     
==========================================
  Files          78       78              
  Lines        8694     8694              
==========================================
+ Hits         5144     5188      +44     
+ Misses       3550     3506      -44     

see 4 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.