Skip to content

Move Dokka API-docs publishing out of the release workflow - #83

Merged
aleksandar-apostolov merged 2 commits into
developfrom
aleksandarapostolov/and-1617-move-dokka-api-docs-publishing-out-of-the-release-workflow
Oct 7, 2026
Merged

aleksandar-apostolov merged 2 commits into
developfrom
aleksandarapostolov/and-1617-move-dokka-api-docs-publishing-out-of-the-release-workflow

Conversation

@aleksandar-apostolov

Copy link
Copy Markdown
Contributor

Goal

Closes AND-1617 — artifacts no longer wait on the Dokka HTML build (Chat 11m30s, Video 7m17s, Core/Feeds ~3m per release).

Implementation

  • release.yml: dropped the Dokka and gh-pages steps from publish-release.
  • New publish-api-docs.yml: builds dokkaGeneratePublicationHtml and pushes it to gh-pages. Callable (workflow_call), plus push: main and workflow_dispatch for this repo's own docs. Uses GITHUB_TOKEN with contents: write by default; newer runs cancel older ones.
  • README: "API Docs" section with the caller snippet. SDK repos trigger it on push to main, which release.yml fast-forwards after every develop release.

Testing

actionlint clean on all workflows. The first push to main after merge exercises the push trigger.

Generating Dokka HTML ran inside publish-release before ./gradlew publish,
delaying artifacts by up to ~11 minutes. publish-api-docs.yml now builds and
pushes the docs on push to main, which the release fast-forwards.
@aleksandar-apostolov aleksandar-apostolov added the pr:workflows The PR includes changes to GitHub actions & workflows label Oct 7, 2026
@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

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.

@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d02d5e61-9493-472d-acf2-fd0705fd7367
  • 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

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

Comment thread .github/workflows/publish-api-docs.yml Outdated
Comment thread .github/workflows/publish-api-docs.yml
Manual runs publish only from main, so a feature branch can't replace the
live docs. Failures post to the Android CI/CD Slack webhook. This repo's
own docs move to an api-docs.yml caller, as releases do.
@aleksandar-apostolov
aleksandar-apostolov merged commit e000dee into develop Oct 7, 2026
7 checks passed
@aleksandar-apostolov
aleksandar-apostolov deleted the aleksandarapostolov/and-1617-move-dokka-api-docs-publishing-out-of-the-release-workflow branch October 7, 2026 12:31
@stream-public-bot stream-public-bot added the released Included in a release label Oct 7, 2026
@stream-public-bot

Copy link
Copy Markdown
Collaborator

🚀 Available in v1.0.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:workflows The PR includes changes to GitHub actions & workflows released Included in a release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants