Skip to content

CI: docgen demo-function smoke (issue #9); ensure Mike Farah yq in regression#10

Merged
jmjava merged 1 commit intomainfrom
cursor/docgen-demo-function-ci-58db
May 6, 2026
Merged

CI: docgen demo-function smoke (issue #9); ensure Mike Farah yq in regression#10
jmjava merged 1 commit intomainfrom
cursor/docgen-demo-function-ci-58db

Conversation

@jmjava
Copy link
Copy Markdown
Owner

@jmjava jmjava commented May 5, 2026

Summary

Addresses issue #9: there were no remaining demo_function, docgen-shim, or PYTHONPATH=…docgen-shim references in this repo. This PR adds an explicit GitHub Actions smoke job that installs upstream docgen from git and invokes docgen demo-function, treating exit code 78 as success for the intentional placeholder manifest (neutral skip).

Changes

  • .github/workflows/docgen-demo-function.ymlpip install "docgen @ git+https://github.com/jmjava/documentation-generator.git@b880ba7a96c35fa32672f217e68c3e3592fb2be1" then docgen demo-function with --no-narration; map 780.
  • ci/docgen-demo-function-smoke.docgen.yaml — minimal placeholder Playwright manifest (no URL) so the job is fast and deterministic.
  • scripts/common.sh + scripts/run-regression.sh — when the wrong PyPI yq is first on PATH, auto-download Mike Farah yq to REPO_ROOT/.tools/ so Phase 1 (yq -o=json in stack-graph.sh) works. .gitignore ignores .tools/.

Verification

  • bash scripts/run-regression-agent.sh — exit 0 (local-only tier after env setup in the agent image).

Pin note

DOCGEN_GIT_REF is set to documentation-generator@main HEAD at implementation time (b880ba7…) because that commit includes the demo-function subcommand; the older pin in downstream docs predates that CLI.

Open in Web Open in Cursor 

…ssion

- New workflow installs docgen from jmjava/documentation-generator@b880ba7
  and runs docgen demo-function against a placeholder manifest; exit 78 is
  success (neutral skip per issue #9).
- Regression Phase 1: auto-download Mike Farah yq to .tools/ when PATH has the
  unrelated PyPI yq wrapper (fixes jq -o=json confusion).
- Ignore .tools/ for the downloaded binary.

Co-authored-by: John Menke <jmjava@gmail.com>
@jmjava jmjava marked this pull request as ready for review May 6, 2026 01:13
@jmjava jmjava merged commit 7af7d53 into main May 6, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants