Skip to content

fix: Sphinx 8 deploy flags and re-enable automatic releases - #227

Merged
busla merged 2 commits into
mainfrom
fix/push-deploy-sphinx8-flags
Feb 13, 2026
Merged

fix: Sphinx 8 deploy flags and re-enable automatic releases#227
busla merged 2 commits into
mainfrom
fix/push-deploy-sphinx8-flags

Conversation

@busla

@busla busla commented Feb 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Fix production deployment failure caused by Sphinx 8 boolean flag changes in push.yml
  • Re-enable automatic GitHub releases on push to main in release.yml

Changes

push.yml — Deploy build fix

  • Changed -D html_show_sourcelink=false to =0 and -D html_copy_source=false to =0 (Sphinx 8 requires 0/1, not false/true)
  • Removed 2>/dev/null that was silently hiding build errors

release.yml — Automatic releases

  • Re-added push trigger for main branch (removed at 282c701 when Sphinx builds were failing)
  • Removed if: github.event_name == 'workflow_dispatch' guard on create-release job that prevented releases on push events
  • Added concurrency group to prevent concurrent release attempts
  • Path filters: projects/** and cli/** (excludes .github/** so CI-only changes don't create releases)

Context

The deploy failure on main was caused by the inline sphinx-build step in push.yml's deploy-production job — separate from the reusable build-docs-optimized.yml which was already fixed in PR #225.

The release workflow had its push trigger removed because historical runs failed during the build phase. Now that Sphinx 8 builds are working correctly, the trigger is safe to restore.

Test plan

  • PR CI passes (validates workflow syntax)
  • After merge: push.yml deployment succeeds on main
  • After merge: release.yml creates a GitHub release automatically

Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com

Summary by CodeRabbit

  • Chores
    • Adjusted production documentation build settings for consistent output.
    • Updated release workflow to also trigger on selected pushes, added concurrency control, and simplified release creation so releases run when the pipeline succeeds.

The deploy-production job in push.yml has its own inline sphinx-build
that was not updated alongside build-docs-optimized.yml in PR #225.

Sphinx 8 strictly validates -D boolean flags and rejects 'false',
requiring '0' instead. Also removed 2>/dev/null that was hiding all
build errors.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@busla
busla temporarily deployed to fix/push-deploy-sphinx8-flags February 13, 2026 13:46 — with GitHub Actions Inactive
@coderabbitai

coderabbitai Bot commented Feb 13, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

Updated two Sphinx build directives in the production build step of .github/workflows/push.yml from boolean false to numeric 0 for html_show_sourcelink and html_copy_source. Also modified .github/workflows/release.yml to add push-triggering for main with path filters, introduce a concurrency group, and remove a workflow_dispatch-only gate on release creation.

Changes

Cohort / File(s) Summary
Sphinx build tweak
/.github/workflows/push.yml
Replaced -D html_show_sourcelink=false and -D html_copy_source=false with -D html_show_sourcelink=0 and -D html_copy_source=0 in the production build command.
Release workflow updates
/.github/workflows/release.yml
Added push trigger for main with projects/** and cli/** path filters; introduced concurrency: group: release with cancel-in-progress: false; removed conditional that limited the Create Release job to workflow_dispatch, so release creation runs when upstream jobs succeed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the two main changes: fixing Sphinx 8 boolean flags in the push deploy workflow and re-enabling automatic releases.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/push-deploy-sphinx8-flags

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
.github/workflows/release.yml (1)

83-86: Clean up the unused bump_type input for clarity.

The bump_type input (lines 6–12) is defined for workflow_dispatch but never referenced anywhere in the workflow. Version generation relies entirely on CalVer (lines 42–68), making bump_type dead configuration. Removing it will help keep the workflow easier to understand for future contributors working on your educational platform.

This is a minor cleanup that would reduce cognitive overhead when others review or maintain this automation.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Feb 13, 2026

Copy link
Copy Markdown

📚 PR Documentation Deployed

Your PR documentation is available with enhanced build performance:

🔗 PR Documentation: https://edbook.github.io/haskoli-islands/fix/push-deploy-sphinx8-flags/
🔗 Individual Projects: Available at https://edbook.github.io/haskoli-islands/fix/push-deploy-sphinx8-flags/[project-name]/

✨ Performance Features:

  • ⚡ Parallel builds (4x faster)
  • 💾 Intelligent caching
  • 🏗️ Optimized Sphinx configuration
  • 📊 Build statistics included

Version: 26.02.13.1355+bba73f3

The release workflow's push trigger was removed at 282c701 because
historical runs failed. The root cause was a Sphinx build failure,
not the trigger itself.

Changes:
- Re-add push trigger for main branch with path filters (projects/, cli/)
- Remove workflow_dispatch-only guard on create-release job
- Add concurrency group to prevent concurrent release attempts
- Exclude .github/** from paths to avoid releases on CI-only changes

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@busla busla changed the title fix: update Sphinx 8 boolean flags in push deploy build step fix: Sphinx 8 deploy flags and re-enable automatic releases Feb 13, 2026
@busla
busla merged commit ff78e52 into main Feb 13, 2026
4 checks passed
@busla
busla deleted the fix/push-deploy-sphinx8-flags branch February 13, 2026 14:11
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.

1 participant