From 3e18101951cda5a7446f4c7e452a21fadc15124c Mon Sep 17 00:00:00 2001 From: Dylan Gormley Date: Tue, 29 Sep 2026 17:43:49 -0500 Subject: [PATCH 1/2] ci: address Dependabot updates and workflow maintenance --- .github/dependabot.yml | 12 +++++++ .github/workflows/continuous-deployment.yml | 7 +++-- .github/workflows/continuous-integration.yml | 12 +++---- .github/workflows/docs.yml | 33 +++++++++++++++++--- .github/workflows/stale.yml | 3 +- 5 files changed, 52 insertions(+), 15 deletions(-) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..583513d --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: weekly + day: monday + open-pull-requests-limit: 5 + groups: + actions-minor-and-patch: + patterns: ["*"] + update-types: [minor, patch] diff --git a/.github/workflows/continuous-deployment.yml b/.github/workflows/continuous-deployment.yml index 6000c85..40a5b2e 100644 --- a/.github/workflows/continuous-deployment.yml +++ b/.github/workflows/continuous-deployment.yml @@ -9,21 +9,22 @@ permissions: pull-requests: write jobs: release-please: + if: github.repository == 'CHIMEFRB/datatrail-cli' runs-on: ubuntu-latest steps: - name: Create release id: release-please - uses: googleapis/release-please-action@v5 + uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5 - name: Checkout code if: ${{ steps.release-please.outputs.release_created }} - uses: actions/checkout@v7 + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 with: fetch-depth: 1 - name: Install uv if: ${{ steps.release-please.outputs.release_created }} - uses: astral-sh/setup-uv@v10.0.1 + uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0 with: enable-cache: false python-version: "3.13" diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index 737c927..24103a5 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -18,10 +18,10 @@ jobs: Pre-commit-checks: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v7 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 - name: Set up Python 3.13 - uses: actions/setup-python@v7 + uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7 with: python-version: 3.13 @@ -46,10 +46,10 @@ jobs: - "3.13" - "3.14" steps: - - uses: actions/checkout@v7 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 - name: Install uv - uses: astral-sh/setup-uv@v10.0.1 + uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0 with: enable-cache: true cache-dependency-glob: "uv.lock" @@ -93,14 +93,14 @@ jobs: rm -f -- "$RUNNER_TEMP/CANFAR_NETRC" "$HOME/.ssl/cadcproxy.pem" - name: Upload coverage to Coveralls - uses: coverallsapp/github-action@v2 + uses: coverallsapp/github-action@8d6379e14d29928660c4ba802d8e85393440b329 # v2 with: github-token: ${{ secrets.GITHUB_TOKEN }} path-to-lcov: "coverage.lcov" fail-on-error: false - name: Upload coverage to Codecov - uses: codecov/codecov-action@v3 + uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1 with: fail_ci_if_error: false token: ${{ secrets.CODECOV_TOKEN }} diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 905da21..cc12743 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,21 +1,44 @@ name: Documentation on: push: - branches: - - main + branches: [main] paths: - "docs/**" + - "mkdocs*.yml" + - "pyproject.toml" + - "uv.lock" - ".github/workflows/docs.yml" + pull_request: + paths: + - "docs/**" + - "mkdocs*.yml" + - "pyproject.toml" + - "uv.lock" + - ".github/workflows/docs.yml" + workflow_dispatch: permissions: contents: read jobs: - mkdocs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0 + with: + python-version: "3.13" + enable-cache: true + - run: uv sync --locked --group docs + - run: uv run --no-sync mkdocs build --strict --config-file mkdocs-site.yml + + handbook: + if: github.repository == 'CHIMEFRB/datatrail-cli' && github.event_name == 'push' + needs: build runs-on: ubuntu-latest steps: - - name: Build chimefrb/handbook - uses: peter-evans/repository-dispatch@v3 + - name: Build the upstream handbook + uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1 with: token: ${{ secrets.BUILD_HANDBOOK_TOKEN }} repository: chimefrb/handbook diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 99da488..dfed2ff 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -11,10 +11,11 @@ permissions: jobs: close_stale_prs: + if: github.repository == 'CHIMEFRB/datatrail-cli' runs-on: ubuntu-latest steps: - name: Close stale pull requests - uses: actions/stale@v9 + uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 # v11.0.0 with: days-before-stale: 90 days-before-close: 7 From 7aa1a882fb9f03f5024dc8ca2f9dc5c30a05cfe9 Mon Sep 17 00:00:00 2001 From: Dylan Gormley Date: Tue, 29 Sep 2026 20:04:37 -0500 Subject: [PATCH 2/2] ci: use readable action version tags --- .github/workflows/continuous-deployment.yml | 6 +++--- .github/workflows/continuous-integration.yml | 12 ++++++------ .github/workflows/docs.yml | 6 +++--- .github/workflows/stale.yml | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/workflows/continuous-deployment.yml b/.github/workflows/continuous-deployment.yml index 40a5b2e..874ff39 100644 --- a/.github/workflows/continuous-deployment.yml +++ b/.github/workflows/continuous-deployment.yml @@ -14,17 +14,17 @@ jobs: steps: - name: Create release id: release-please - uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5 + uses: googleapis/release-please-action@v5 - name: Checkout code if: ${{ steps.release-please.outputs.release_created }} - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + uses: actions/checkout@v7 with: fetch-depth: 1 - name: Install uv if: ${{ steps.release-please.outputs.release_created }} - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0 + uses: astral-sh/setup-uv@v10.2.0 with: enable-cache: false python-version: "3.13" diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index 24103a5..bd0c70f 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -18,10 +18,10 @@ jobs: Pre-commit-checks: runs-on: ubuntu-latest steps: - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + - uses: actions/checkout@v7 - name: Set up Python 3.13 - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7 + uses: actions/setup-python@v7 with: python-version: 3.13 @@ -46,10 +46,10 @@ jobs: - "3.13" - "3.14" steps: - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + - uses: actions/checkout@v7 - name: Install uv - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0 + uses: astral-sh/setup-uv@v10.2.0 with: enable-cache: true cache-dependency-glob: "uv.lock" @@ -93,14 +93,14 @@ jobs: rm -f -- "$RUNNER_TEMP/CANFAR_NETRC" "$HOME/.ssl/cadcproxy.pem" - name: Upload coverage to Coveralls - uses: coverallsapp/github-action@8d6379e14d29928660c4ba802d8e85393440b329 # v2 + uses: coverallsapp/github-action@v2 with: github-token: ${{ secrets.GITHUB_TOKEN }} path-to-lcov: "coverage.lcov" fail-on-error: false - name: Upload coverage to Codecov - uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1 + uses: codecov/codecov-action@v7.1.1 with: fail_ci_if_error: false token: ${{ secrets.CODECOV_TOKEN }} diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index cc12743..03c7b5e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,8 +24,8 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 - - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0 + - uses: actions/checkout@v7 + - uses: astral-sh/setup-uv@v10.2.0 with: python-version: "3.13" enable-cache: true @@ -38,7 +38,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Build the upstream handbook - uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 # v4.0.1 + uses: peter-evans/repository-dispatch@v4.0.1 with: token: ${{ secrets.BUILD_HANDBOOK_TOKEN }} repository: chimefrb/handbook diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index dfed2ff..d0f1d55 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Close stale pull requests - uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 # v11.0.0 + uses: actions/stale@v11.0.0 with: days-before-stale: 90 days-before-close: 7