Publish API docs on push to main by aleksandar-apostolov · Pull Request #6787 · GetStream/stream-chat-android

aleksandar-apostolov · 2026-10-07T12:06:31Z

Goal

Refs AND-1617 — move API-docs publishing to a push-to-main workflow, ahead of dropping it from the release job.

Implementation

New publish-api-docs.yml calls the shared workflow at build-conventions v1.0.1 (d275481) on push to main (+ workflow_dispatch, main only) and passes SLACK_WEBHOOK_ANDROID_CICD for failure alerts.

release.yml stays pinned at 9ea4d20: bumping it pulls in the Stream-repo publishing cutover, which goes in its own PR. Until then the release job still runs Dokka, so docs publish twice per release (same content). The release-time saving lands with that bump.

Testing

actionlint clean. Build-conventions v1.0.1 released through the same path: API Docs ran on the main push and redeployed Pages. After the next release here, it updates getstream.github.io/stream-chat-android.

Adds a caller for the shared publish-api-docs workflow so docs no longer depend on the release job. The release.yml pin is unchanged; until it is bumped, docs are published by both.

github-actions · 2026-10-07T12:06:44Z

PR checklist ✅

All required conditions are satisfied:

Title length is OK (or ignored by label).
At least one pr: label exists.
Sections ### Goal, ### Implementation, and ### Testing are filled, or the PR is bot-authored.
An issue is linked (Linear ticket or GitHub issue), or the PR is bot-authored.

🎉 Great job! This PR is ready for review.

github-actions · 2026-10-07T12:10:12Z

SDK Size Comparison 📏

SDK	Before	After	Status
stream-chat-android-client	6.20 MB	6.20 MB	🟢
stream-chat-android-ui-components	11.51 MB	11.51 MB	🟢
stream-chat-android-compose	13.18 MB	13.18 MB	🟢

coderabbitai · 2026-10-07T12:12:59Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI
Review profile: CHILL
Plan: Advanced
Run ID: 291c8455-cc9e-4725-83fe-3d836646fb40

📥 Commits

Reviewing files that changed from the base of the PR and between 3de78e4 and 0963efc.

📒 Files selected for processing (1)

.github/workflows/publish-api-docs.yml

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Walkthrough

Adds a GitHub Actions workflow that runs on pushes to main or manual dispatch. Its docs job calls a pinned API-docs reusable workflow and receives contents: write permission.

Changes

API Docs Publishing

Layer / File(s)	Summary
Configure API docs publishing `.github/workflows/publish-api-docs.yml`	Adds push and manual triggers. The `docs` job calls the pinned reusable workflow with `contents: write` permission.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Feature

Suggested reviewers: andremion

Merge Risk: ⚪ Minimal · up to 0963e

Pushes to main and manual dispatch invoke the pinned API-docs publisher. No concrete merge-blocking risk is established.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly and concisely describes the new workflow that publishes API docs when changes reach `main`.
Description check	✅ Passed	The description explains the goal, implementation, and testing. The UI, checklist, reviewer checklist, and GIF sections are omitted; the UI and GIF sections do not appear relevant to this workflow cha…

✨ Finishing Touches

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

_{A rabbit checks the docs at dawn
A workflow hops and carries on
When main receives a fresh new change
The docs job runs along its range
A manual start can join the play
Then API docs find their way}

_{Comment @coderabbitai help to get the list of available commands.}

Re-pins to the conventions commit that alerts on docs failures.

sonarqubecloud · 2026-10-07T12:45:38Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

stream-public-bot · 2026-10-08T08:07:35Z

🚀 Available in v7.14.0

ci: publish API docs on push to main

0963efc

Adds a caller for the shared publish-api-docs workflow so docs no longer depend on the release job. The release.yml pin is unchanged; until it is bumped, docs are published by both.

aleksandar-apostolov requested a review from a team as a code owner October 7, 2026 12:06

aleksandar-apostolov added the pr:ci CI changes label Oct 7, 2026

aleksandar-apostolov added 2 commits October 7, 2026 14:28

ci: pass the Slack webhook to the API docs workflow

1b8ae55

Re-pins to the conventions commit that alerts on docs failures.

ci: pin build-conventions v1.0.1

45355e6

gpunto approved these changes Oct 7, 2026

View reviewed changes

andremion approved these changes Oct 7, 2026

View reviewed changes

aleksandar-apostolov added this pull request to the merge queue Oct 7, 2026

Merged via the queue into develop with commit 0edb219 Oct 7, 2026
20 checks passed

aleksandar-apostolov deleted the aleksandarapostolov/and-1617-move-dokka-api-docs-publishing-out-of-the-release-workflow branch October 7, 2026 14:29

stream-public-bot added the released Included in a release label Oct 8, 2026

Navigation Menu

Repository navigation

Publish API docs on push to main - #6787

Publish API docs on push to main#6787
aleksandar-apostolov merged 3 commits into
developfrom
aleksandarapostolov/and-1617-move-dokka-api-docs-publishing-out-of-the-release-workflow

aleksandar-apostolov commented Oct 7, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 7, 2026

Uh oh!

github-actions Bot commented Oct 7, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 7, 2026 •

edited

Loading

Uh oh!

sonarqubecloud Bot commented Oct 7, 2026

Uh oh!

Uh oh!

stream-public-bot commented Oct 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

aleksandar-apostolov commented Oct 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Goal

Implementation

Testing

Uh oh!

github-actions Bot commented Oct 7, 2026

PR checklist ✅

Uh oh!

github-actions Bot commented Oct 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SDK Size Comparison 📏

Uh oh!

coderabbitai Bot commented Oct 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

sonarqubecloud Bot commented Oct 7, 2026

Quality Gate passed

Uh oh!

Uh oh!

stream-public-bot commented Oct 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aleksandar-apostolov commented Oct 7, 2026 •

edited

Loading

github-actions Bot commented Oct 7, 2026 •

edited

Loading

coderabbitai Bot commented Oct 7, 2026 •

edited

Loading