Skip to content

ci: publish docs artifact for the portal mirror - #634

Merged
pratyush618 merged 1 commit into
masterfrom
ci/docs-portal-mirror
Aug 5, 2026
Merged

ci: publish docs artifact for the portal mirror#634
pratyush618 merged 1 commit into
masterfrom
ci/docs-portal-mirror

Conversation

@kartikeya-27

@kartikeya-27 kartikeya-27 commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

docs.byteveda.org/<slug>/ 404s today. GitHub Pages binds a custom domain to exactly
one repository, so this repo cannot serve a subpath of a domain held by
ByteVeda/byteveda.site — setting the domain here just reports already taken by
another repository
.

Instead the docs portal mirrors each tool's build into its own export
(ByteVeda/byteveda.site#220).
This repo's own byteveda.github.io/<slug>/ site is unaffected — the docs are copied,
not moved.

The portal cannot use the existing github-pages artifact: upload-pages-artifact
hardcodes a 1-day retention, so it has always expired by the time the portal next
builds (all five tool repos currently report expired: true). This adds one step
publishing the same directory as docs-dist with a 90-day retention.

No change to how this repo builds or deploys its docs.

Summary by CodeRabbit

  • Chores
    • Built documentation is now uploaded as a downloadable artifact for portal mirroring.
    • Documentation artifacts are retained for 90 days and generated on pushes or manual runs.

@github-actions github-actions Bot added the ci label Aug 5, 2026
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6bb99856-5c3c-422a-b026-1fe4d4debfed

📥 Commits

Reviewing files that changed from the base of the PR and between 54d19a2 and dd3edc3.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • ByteVeda/taskito (manual)

📝 Walkthrough

Walkthrough

The documentation workflow now uploads the built client documentation as a docs-dist artifact with 90-day retention on pushes and manual workflow dispatches.

Changes

Documentation artifact upload

Layer / File(s) Summary
Conditional documentation artifact upload
.github/workflows/docs.yml
The workflow uploads docs/build/client as docs-dist with 90-day retention when the workflow runs from a push or manual dispatch.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: pratyush618

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly matches the changeset: it describes adding a CI step to publish documentation as an artifact for the portal mirror, which is exactly what the workflow change accomplishes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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.

@pratyush618
pratyush618 merged commit ca16fa7 into master Aug 5, 2026
20 checks passed
@pratyush618
pratyush618 deleted the ci/docs-portal-mirror branch August 5, 2026 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants