Skip to content

chore: fix docs and web example workflows#985

Merged
hiroshihorie merged 4 commits intomainfrom
hiroshi/fix-docs
Feb 6, 2026
Merged

chore: fix docs and web example workflows#985
hiroshihorie merged 4 commits intomainfrom
hiroshi/fix-docs

Conversation

@hiroshihorie
Copy link
Member

@hiroshihorie hiroshihorie commented Feb 6, 2026

Summary by CodeRabbit

  • Chores
    • Streamlined web example deployment with updated tools and automated publishing.
    • Enabled automated documentation publishing on repository updates.

@coderabbitai
Copy link

coderabbitai bot commented Feb 6, 2026

📝 Walkthrough

Walkthrough

Two GitHub Actions workflows modified: deploy-web.yaml modernizes Flutter web deployment by replacing manual git operations with peaceiris/actions-gh-pages action, while publish-docs.yaml introduces a new workflow that generates Dart documentation and uploads it to S3 on main branch pushes.

Changes

Cohort / File(s) Summary
Web Deployment Workflow
.github/workflows/deploy-web.yaml
Updated job naming, Flutter and action versions (checkout@v4, flutter-action@v2), removed redundant setup steps, added explicit web build step, replaced multi-step git-based deployment with peaceiris/actions-gh-pages@v4 using GITHUB_TOKEN. Added workflow permissions for contents write.
Documentation Publishing Workflow
.github/workflows/publish-docs.yaml
New workflow triggered on main branch pushes and manual dispatch. Sets up Flutter, generates Dart documentation via dart doc, and deploys output to S3 bucket using AWS credentials from secrets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Workflows now hop with grace so bright,
GitHub Pages deploy with all-new might!
And docs to S3 bound with care,
The pipelines dance through the digital air!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title 'chore: fix docs and web example workflows' accurately describes the main changes: updates to both the publish-docs.yaml and deploy-web.yaml workflow files.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch hiroshi/fix-docs

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.

@hiroshihorie hiroshihorie marked this pull request as ready for review February 6, 2026 09:44
@hiroshihorie hiroshihorie changed the title Hiroshi/fix docs chore: fix docs and web example workflows Feb 6, 2026
@hiroshihorie hiroshihorie merged commit fa7db38 into main Feb 6, 2026
17 checks passed
@hiroshihorie hiroshihorie deleted the hiroshi/fix-docs branch February 6, 2026 10:04
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