Skip to content

CI: Harden GHA configuration #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+31 −7
Open

CI: Harden GHA configuration #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f159d6
CI: pin actions by SHA
tacaswell Jul 18, 2025
1372889
CI: auto-fix via zizmor
tacaswell Jul 18, 2025
6ae6dc5
CI: Restrict default permissions
tacaswell Jul 18, 2025
fa8f3d4
CI: add dependabot config file for GHA
tacaswell Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/" # Location of your workflow files
schedule:
interval: "weekly" # Options: daily, weekly, monthly
2 changes: 2 additions & 0 deletions .github/workflows/binder-on-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Reference https://mybinder.readthedocs.io/en/latest/howto/gh-actions-badges.html
name: Binder Badge
permissions:
contents: read
on:
pull_request_target:
types: [opened]
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/docs.yml
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on matplotlib/mpl-third-party#192 (comment), this is probably going to break the Publish step.

Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
name: Docs
permissions:
contents: read
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this, or perhaps something else seems to have made the docs build hang forever?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs build fixed by #605


on: [push, pull_request]

Expand All @@ -11,8 +13,10 @@ jobs:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install Conda environment with Micromamba
uses: mamba-org/setup-micromamba@v2
uses: mamba-org/setup-micromamba@b09ef9b599704322748535812ca03efb2625677b # v2
with:
environment-file: dev-environment.yml
- name: Install
Expand All @@ -21,7 +25,7 @@ jobs:
run: make -C docs html
- name: Publish
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
uses: peaceiris/actions-gh-pages@v4
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
Expand Down
12 changes: 9 additions & 3 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
name: Tests
permissions:
contents: read

on:
push:
Expand All @@ -20,9 +22,11 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install Conda environment with Micromamba
uses: mamba-org/setup-micromamba@v2
uses: mamba-org/setup-micromamba@b09ef9b599704322748535812ca03efb2625677b # v2
with:
environment-file: dev-environment.yml

Expand Down Expand Up @@ -64,9 +68,11 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install Conda environment with Micromamba
uses: mamba-org/setup-micromamba@v2
uses: mamba-org/setup-micromamba@b09ef9b599704322748535812ca03efb2625677b # v2
with:
environment-file: dev-environment.yml
create-args: >-
Expand Down Expand Up @@ -134,7 +140,7 @@ jobs:
# https://github.com/pymmcore-plus/pymmcore-widgets/blob/5e233384e223ca00101ef4b741d3c525a5cff9c9/.github/workflows/cron.yml#L49
- name: Report Failures
if: failure() && github.event_name == 'schedule'
uses: JasonEtco/create-an-issue@v2
uses: JasonEtco/create-an-issue@1b14a70e4d8dc185e5cc76d3bec9eab20257b2c5 # v2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This probably needs some kind of write permission?

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OS: ${{ matrix.os }}
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
name: Publish Package
permissions:
contents: read

on:
release:
Expand All @@ -9,9 +11,11 @@ jobs:
steps:

- uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install Conda environment with Micromamba
uses: mamba-org/setup-micromamba@v2
uses: mamba-org/setup-micromamba@b09ef9b599704322748535812ca03efb2625677b # v2
with:
environment-name: ipympl-release
create-args: >-
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/update_galata_references.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,15 @@ jobs:
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
persist-credentials: false

- name: Checkout the branch from the PR that triggered the job
run: gh pr checkout ${{ github.event.issue.number }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Install Conda environment with Micromamba
uses: mamba-org/setup-micromamba@v2
uses: mamba-org/setup-micromamba@b09ef9b599704322748535812ca03efb2625677b # v2
with:
environment-file: dev-environment.yml
create-args: >-
Expand Down
Loading