Skip to content

Bump project version to 1.1.7 across canonical release surfaces#1352

Merged
SkBlaz merged 3 commits intomasterfrom
copilot/bump-version-where-relevant-another-one
Apr 19, 2026
Merged

Bump project version to 1.1.7 across canonical release surfaces#1352
SkBlaz merged 3 commits intomasterfrom
copilot/bump-version-where-relevant-another-one

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 18, 2026

  • Inspect PR comment and confirm failing CI step/log details for docs-examples workflow
  • Regenerate docs outputs locally using scripts/generate_docs_outputs.py
  • Commit only updated files under examples/docs_outputs/
  • Run targeted docs-output validation checks
  • Reply on PR comment with commit hash referencing the fix

Copilot AI linked an issue Apr 18, 2026 that may be closed by this pull request
Closed
Copilot AI changed the title [WIP] Bump version where relevant Bump project version to 1.1.7 across canonical release surfaces Apr 18, 2026
Copilot AI requested a review from SkBlaz April 18, 2026 19:18
@SkBlaz
Copy link
Copy Markdown
Owner

SkBlaz commented Apr 19, 2026

@copilot Root cause: the job fails at the PR divergence check, not during example execution.

  • Workflow step: .github/workflows/docs-examples.yml (ref 10f105c66f7046035038c9f6c170291e44869799), lines 66–74
  • Failing command: git diff --exit-code examples/docs_outputs/
  • Log evidence: Documentation outputs have diverged! and exit code 1

That means scripts/generate_docs_outputs.py produced changes under examples/docs_outputs/ that are not committed in the PR.

Solution (what to change in this PR)

Run the generator locally and commit the updated outputs:

python scripts/generate_docs_outputs.py
git add examples/docs_outputs/
git commit -m "Update generated documentation outputs"

Then push to PR branch.

Why this happened

Your generator script intentionally normalizes volatile values (timestamps, memory addresses, elapsed times) in scripts/generate_docs_outputs.py (lines 107–124), but if example behavior/output format changed, the generated .txt/.err files and/or manifest.json under examples/docs_outputs/ will legitimately differ and must be checked in.

Optional hardening (code suggestion)

To reduce local/CI drift further, ensure deterministic locale in the workflow too (even though script sets env internally). Add this env block to generation/validation steps in .github/workflows/docs-examples.yml:

env:
  MPLBACKEND: Agg
  PYTHONHASHSEED: "0"
  LC_ALL: C.UTF-8
  LANG: C.UTF-8
  OMP_NUM_THREADS: "1"
  OPENBLAS_NUM_THREADS: "1"
  MKL_NUM_THREADS: "1"
  NUMEXPR_NUM_THREADS: "1"

But the immediate fix for this failing job is: commit the changed examples/docs_outputs/ files generated by the script.

Agent-Logs-Url: https://github.com/SkBlaz/py3plex/sessions/c801e73a-cb00-42fc-855b-8f33734e1c6d

Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 19, 2026

@copilot Root cause: the job fails at the PR divergence check, not during example execution.

  • Workflow step: .github/workflows/docs-examples.yml (ref `10f105c66f7046035038c9f6c170291e4486979...

Fixed in bbabcf6. I reproduced the docs-examples failure path, regenerated outputs with python scripts/generate_docs_outputs.py, and committed the updated artifact under examples/docs_outputs/ (dsl_patterns_quick_reference.txt). I also ran python scripts/validate_docs_outputs.py --verbose and python -m pytest tests/test_docs_examples.py -q locally to confirm it passes.

@SkBlaz SkBlaz marked this pull request as ready for review April 19, 2026 13:34
@SkBlaz SkBlaz merged commit 0e16861 into master Apr 19, 2026
37 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.

vb

2 participants