Repository navigation
Conversation
| path: benchx_examples/examples/pyperf-suite/out | ||
| if-no-files-found: warn | ||
| retention-days: 14 | ||
| uses: ev-br/benchx_examples/.github/workflows/reusable-example.yml@ci_exec_md |
There was a problem hiding this comment.
Blocker until benchx-dev/benchx_examples#16 lands: with the new push: main trigger this runs a fork's mutable branch on main, and its output is what the site publishes.
| fi | ||
| done <<< "$names" | ||
| done <<< "$runs" | ||
| if [ "$count" -eq 0 ]; then |
There was a problem hiding this comment.
On main this deploys an Examples page that says "No example was built". That happens on the merge of this PR (docs build ~15s vs ~45s for pyperf-suite, and no earlier run on main has the artifact), after 14 quiet days, and on any gh failure hidden by || true. Fail, or skip the deploy, on main when nothing was found?
| # it succeeded. The run for the push being built is usually still going, so the page | ||
| # is typically the one from the push before. Artifacts expire after 14 days; an example | ||
| # without an artifact is left out of the site, with a warning. | ||
| - name: Download the example pages from the latest e2e runs on main |
There was a problem hiding this comment.
Could build instead needs: a job that calls the reusable workflow, and download docs-* from the same run? That drops the cross-run lookup, actions: read, the one-push lag, the artifact expiry and the two-step manual redeploy, for ~1 min per docs build (more as examples are added).
|
|
||
| - id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
| uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1 |
There was a problem hiding this comment.
The action major bumps are unrelated to the examples, and configure-pages / deploy-pages are not exercised here (deploy is skipped on PRs). Separate PR?
| notes.append(f"{workflow} not found, so there is no list of the examples that CI runs " | ||
| "(name them with -e NAME)") | ||
| return [] | ||
| names = re.findall(r"^\s+example:\s*([A-Za-z0-9_-]+)\s*$", workflow.read_text(), re.M) |
There was a problem hiding this comment.
This script is not run in CI and depends on the layout of another repo's e2e.yml, so it can break unnoticed. A CI smoke run (-e pyperf-suite) would cover it.
|
Thanks for the review @rok !
Other examples in |
This is a companion to benchx-dev/benchx_examples#16, which lays the ground work for making examples from
benchx_examplesexecutable.The end goal is: that the examples stay current, and are executed on CI. Moreover:
benchx_examplesCI runs examples for PRs in the _examples repo against the releasedbenchx.benchxPRs run examples inbenchxCITo build the new doc site locally, use
which expects to find the examples checkout of benchx-dev/benchx_examples#16 at
../benchx_examples.Once the example PR lands, I'll change this one to look at
benchx_examplesmain not a PR branch.To keep the diffs small, I only hooked up a single example for now.
The locally built page looks like this:
Of course, examples themselves might need a rewrite for readability, which I also did not do just yet (to keep the diff sizes under control).