Skip to content

Publish Swift API reference to GitHub Pages - #950

Open
markmur wants to merge 1 commit into
mainfrom
swift-reference-pages
Open

markmur wants to merge 1 commit into
mainfrom
swift-reference-pages

Conversation

@markmur

@markmur markmur commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Adds a GitHub Pages API reference for ShopifyCheckoutKit and ShopifyAcceleratedCheckouts. dev swift docs uses xcodebuild docbuild, merges both DocC archives into one navigable site, and prepares it for static hosting.

Publishing follows Swift release tags, including prereleases. The workflow builds the tagged sources, supports republishing an existing release, and uploads preview artifacts for pull requests. The release automation explicitly dispatches documentation publishing because releases created with GITHUB_TOKEN do not trigger release workflows. Generated documentation stays out of Git.

Before the first deployment, GitHub Pages must use GitHub Actions as its source, and the github-pages environment must allow main and Swift release tags. Each deployment replaces the previous reference.

Stack

@github-actions github-actions Bot added the #gsd:50662 Rebase Checkout Kit on UCP label Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Bundle Size Budgets

Budget Size Limits Result
— — — ➖ No configured budgets affected

Bundle and package size

Web bundle sizes cover shipped runtime JavaScript. Package sizes cover the full published archive, including any source maps, declarations, and documentation it contains.

Platform Measurement Compression Base Head Delta
- - - - - -
How sizes are measured

Measured from the PR base SHA and PR head SHA. Web bundle rows sum shipped .js, .mjs, and .cjs files under dist/, excluding source maps and declarations. The gzip bundle size sums files compressed individually with gzip -n -9. npm package sizes are gzip-compressed .tgz archives; Android AAR sizes are ZIP archives. Package sizes are not final app binary sizes.

@markmur
markmur marked this pull request as ready for review October 9, 2026 12:29
@markmur
markmur requested a review from a team as a code owner October 9, 2026 12:29
@markmur markmur self-assigned this Oct 9, 2026
@github-actions

github-actions Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Coverage Report

Status Platform / target Lines Branches Functions Report
⏭️ Web — — — Not run for this change
✅ React Native 91.49% 87.3% 100% Full report
⏭️ Embedded Checkout Protocol (TS) — — — Not run for this change

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

React Native — Coverage Report

Lines Statements Branches Functions
Coverage: 91%
90.97% (363/399) 87.29% (213/244) 100% (92/92)

@markmur
markmur force-pushed the swift-reference-pages branch from 411d2b5 to 5a2dea4 Compare October 9, 2026 12:31
@bitrise

bitrise Bot commented Oct 9, 2026

Copy link
Copy Markdown

Bitrise builds

E2E · iOS CI

Install this build

Open Tophat, select your target device, then click Install. Links open on the Mac running Tophat.

SDK Install
Swift Install with Tophat

Checkout Kit E2E results

Status Tags Target Platform OS version tag Device
✅ launch, checkout-presentation, checkout-completion, buyer-identity, preload swift ios latest iPhone 15
iOS 27 Beta

This branch has not been deployed

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

Labels

#gsd:50662 Rebase Checkout Kit on UCP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant