Skip to content

ci: only release on successfull ci#12

Merged
FBumann merged 1 commit intomainfrom
feature/ci
Jan 9, 2026
Merged

ci: only release on successfull ci#12
FBumann merged 1 commit intomainfrom
feature/ci

Conversation

@FBumann
Copy link
Owner

@FBumann FBumann commented Jan 9, 2026

  • Tests (Python 3.10-3.13) with lint, format, tests
  • Docs build check
  • CI Success gate (requires both to pass)

On release (docs.yml):

  • Builds and deploys docs to GitHub Pages

Summary by CodeRabbit

  • Chores
    • Updated CI/CD workflows to validate documentation builds during pull requests and enforce successful test and documentation checks before merging.
    • Modified documentation deployment to only occur on release events.

✏️ Tip: You can customize this high-level summary in your review settings.

  - Tests (Python 3.10-3.13) with lint, format, tests
  - Docs build check
  - CI Success gate (requires both to pass)

  On release (docs.yml):
  - Builds and deploys docs to GitHub Pages
@coderabbitai
Copy link

coderabbitai bot commented Jan 9, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

GitHub Actions workflows are updated to enforce documentation builds during CI pipeline execution. The ci.yml now includes a dedicated docs job and success aggregation check, while docs.yml transitions from push-based to pull-request triggers with conditional deployment guards.

Changes

Cohort / File(s) Summary
CI Pipeline Enhancement
.github/workflows/ci.yml
Adds docs job to build documentation and ci-success aggregation job that enforces both test and docs success; wires dependencies through the pipeline (+32 lines).
Docs Workflow Trigger Modification
.github/workflows/docs.yml
Changes trigger from push to pull_request for main branch; adds conditional guard to Deploy to GitHub Pages step to run only on release events (+2/-1 lines).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 The docs now flow through CI's gentle stream,
With pull requests fueling the build machine,
Success gates aggregate, steady and true,
Where workflows dance in their appointed view! ✨


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3739f28 and b73e602.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml
  • .github/workflows/docs.yml

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.

@FBumann FBumann merged commit afcc9b9 into main Jan 9, 2026
8 of 9 checks passed
This was referenced Jan 22, 2026
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