check_gha_workflow.yml

---
# Workflow to check the time taken to run tests
name: Benchmark test suite

on:
    schedule:

# Uses the cron schedule for github actions
#
# https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#scheduled-events
#
#            ┌───────────── minute (0 - 59)
#            │ ┌───────────── hour (0 - 23)
#            │ │ ┌───────────── day of the month (1 - 31)
#            │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
#            │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
#            │ │ │ │ │
#            │ │ │ │ │
#            │ │ │ │ │
#            * * * * *

    # Run first day of the month at midnight UTC
    -   cron: 0 0 1 * *

    workflow_dispatch:

jobs:
    check_gha_workflow:
        if: github.repository == 'nilearn/nilearn'
        runs-on: ubuntu-latest
        permissions: {}
        steps:
        -   name: Checkout nilearn
            uses: actions/checkout@v4
        -   name: Setup python
            uses: actions/setup-python@v5
            with:
                python-version: 3.12
        -   name: Install dependencies
            run: python -m pip install --requirement maint_tools/requirements.txt
        -   name: Collect and plot test suite run time
            run: python maint_tools/check_gha_workflow.py ${{ secrets.GITHUB_TOKEN }}
        -   name: Upload output
            uses: actions/upload-artifact@v4
            with:
                name: test_runs_timing_outputs
                path: maint_tools/*_runs_timing.*