branch protection rules for this gh-pages branch?

What do you want? No force push?

I set the default branch protection rule on it.

cc @joerick (and h/t for the idea!), could you please confirm if this is what you had in mind?

Since you tagged me, I'll add my two cents! I'd say a better solution would be to have an action deploy that file from main. That saves the extra PR for you to merge, and also allows more adaptability, letting you edit that file at any time, rather than needing the update job to do it.

Something like this would work, I think:

name: Deploy pyodide-cross-build-environments.json to Pages

on:
  push:
    branches:
      - main
    paths:
      # Only runs if this specific file changes
      - pyodide-cross-build-environments.json

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}/api/pyodide-cross-build-environments.json
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Prepare artifact
        run: |
          mkdir -p ./_site/api
          cp pyodide-cross-build-environments.json ./_site/api/pyodide-cross-build-environments.json

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./_site

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

Since you tagged me, I'll add my two cents! I'd say a better solution would be to have an action deploy that file from main. That saves the extra PR for you to merge, and also allows more adaptability, letting you edit that file at any time, rather than needing the update job to do it.

Great suggestion, thank you, @joerick! I think this makes sense to me, I'll switch to your action instead. Just one clarification: doing this will only prevent the extra PR, as the file is in the gh-pages branch and can be edited at any time, even right now.

Once I change to your suggestion, I'll move from "Deploy from a branch" to "GitHub Actions".

branch protection rules for this gh-pages branch?

What do you want? No force push?

I set the default branch protection rule on it.

Thanks @hoodmane, that helps! Also, if you could add another rule that allows only known collaborators to push to the gh-pages branch, that would be great.

Actually, this is no longer needed – we can drop the gh-pages branch altogether now.

Edit 2: I can't delete it as it's now a protected branch – could you delete it from https://github.com/pyodide/pyodide/branches?

I haven't added [skip ci] to the commit message as we'll want this workflow to run now. I additionally added the workflow_dispatch: and made it run on a scheduled job as well, as an extra measure if GitHub ever is down for some time and it doesn't run when merging a PR – it'll run on the next day, at least.

We'll have to merge this to trigger the change, so I shall press the button for now! I've updated the PR title and description accordingly.

I triggered a successful run through a manual trigger: https://github.com/pyodide/pyodide/actions/runs/15116045722

The metadata file is live at https://pyodide.github.io/pyodide/api/pyodide-cross-build-environments.json