Docs: Sphinx → properdocs migration + descending-drive Poisson fix (+ Optuna parallelization) #11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: all-contributors | |
| # Keeps the README All-Contributors table in sync with `.all-contributorsrc` | |
| # (the rc file is the source of truth; the README table is generated from it). | |
| # | |
| # - On push to main: regenerate the table and auto-commit README.md if it drifted, | |
| # so editing `.all-contributorsrc` is enough — you never have to remember to run | |
| # the generator. The bot commit uses the default GITHUB_TOKEN, which does not | |
| # re-trigger workflows, so there is no loop. | |
| # - On pull requests: just fail if the table is stale (we can't push to fork PR | |
| # branches), so drift is still caught before merge. | |
| # | |
| # NOTE: the auto-commit needs to push to main. If main is ever protected to require | |
| # pull requests, that push will be rejected and this job will fail — switch the | |
| # "auto-commit" step for the "fail if stale" check in that case. | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - ".all-contributorsrc" | |
| - "README.md" | |
| - ".github/workflows/all-contributors.yml" | |
| pull_request: | |
| paths: | |
| - ".all-contributorsrc" | |
| - "README.md" | |
| - ".github/workflows/all-contributors.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| jobs: | |
| sync: | |
| name: all-contributors table | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: "22" | |
| - name: Regenerate contributors table from .all-contributorsrc | |
| run: npx --yes all-contributors-cli@6.26.1 generate | |
| - name: Auto-commit regenerated table (push to main) | |
| if: github.event_name == 'push' | |
| run: | | |
| if git diff --quiet -- README.md; then | |
| echo "README table already in sync." | |
| else | |
| git config user.name "github-actions[bot]" | |
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git add README.md | |
| git commit -m "docs: sync All-Contributors table [skip ci]" | |
| git push origin HEAD:main | |
| fi | |
| - name: Fail if README table is out of sync (pull request) | |
| if: github.event_name != 'push' | |
| run: | | |
| if ! git diff --exit-code -- README.md; then | |
| echo "::error::README.md All-Contributors table is stale. Run: npx all-contributors-cli@6.26.1 generate" | |
| exit 1 | |
| fi |