Skip to content

fix(podspec): set CocoaPods README URL#37

Merged
andygruening merged 1 commit into
masterfrom
fix-cocoapods-readme-url
Jun 11, 2026
Merged

fix(podspec): set CocoaPods README URL#37
andygruening merged 1 commit into
masterfrom
fix-cocoapods-readme-url

Conversation

@tolgahan-arikan

Copy link
Copy Markdown
Collaborator

Summary

Adds an explicit versioned CocoaPods s.readme URL so the pod page can render the README for the published release instead of falling back to stale CocoaDocs README metadata. Updates the publishing checklist to preserve that metadata for future releases.

Changes

  • Set s.readme in oms-client-swift-sdk.podspec to the tag-specific raw GitHub README URL.
  • Document the versioned README URL requirement in publishing.md.

Testing

  • git diff --check
  • pod ipc spec oms-client-swift-sdk.podspec
  • Confirmed pod ipc spec resolves readme to https://raw.githubusercontent.com/0xsequence/swift-sdk/0.1.0-alpha.2/README.md
  • curl -fsI https://raw.githubusercontent.com/0xsequence/swift-sdk/0.1.0-alpha.2/README.md returned HTTP 200
  • swift build passes - not run; podspec/docs metadata only
  • swift test passes - not run; podspec/docs metadata only
  • SDK demo app builds - not run; podspec/docs metadata only
  • Trails Actions demo app builds - not run; podspec/docs metadata only

Related

Follow-up to CocoaPods.org rendering stale README content for oms-client-swift-sdk.

@tolgahan-arikan tolgahan-arikan requested a review from a team June 10, 2026 15:51
@claude

claude Bot commented Jun 10, 2026

Copy link
Copy Markdown

Claude finished @tolgahan-arikan's task —— View job


Reviewing PR: CocoaPods README URL Fix

I've completed my review of this pull request against the OMS SDK conventions in AGENTS.md. Here are my findings:

Todo List:

  • Read AGENTS.md and project documentation
  • Examine the podspec changes
  • Review the publishing.md updates
  • Check for security implications
  • Assess against coding conventions
  • Provide comprehensive review feedback

✅ Review Findings

This PR looks excellent and follows all the OMS SDK conventions perfectly:

Security Analysis

  • No security concerns: This change only adds metadata (README URL) to the CocoaPods podspec
  • No private key material: No changes to credential management or session storage
  • P-256 credential safety: No impact on the non-extractable Keychain-backed credentials

Correctness Against AGENTS.md Conventions

  • Surgical changes: Only touches what's necessary (podspec:line 12 and publishing.md:lines 18-20)
  • Platform availability: Not applicable - this is metadata-only
  • Floating-point math: Not applicable - no token amount calculations
  • Path quoting: Not applicable - no shell commands modified
  • Conventional Commits: PR title follows format: fix(podspec): set CocoaPods README URL

Code Quality

  • Simplicity: Minimal change that directly addresses the stated problem
  • No unnecessary complexity: Uses Ruby string interpolation #{s.version} which is idiomatic for podspecs
  • Documentation alignment: Updates publishing.md to preserve this metadata requirement for future releases

Implementation Details

The change adds:

s.readme = "https://raw.githubusercontent.com/0xsequence/swift-sdk/#{s.version}/README.md"

This is exactly what's needed to:

  1. Use versioned README URLs for CocoaPods rendering
  2. Automatically interpolate the version from s.version
  3. Point to the correct GitHub raw file URL format

Test Coverage Assessment

  • Appropriate testing: Author confirmed pod ipc spec validation and URL accessibility
  • No functional tests needed: This is metadata-only, doesn't affect SDK behavior
  • CI will validate: The existing CI pipeline will catch any podspec syntax issues

Publishing Workflow Integration

The publishing.md update ensures future maintainers will preserve the versioned README URL requirement, which demonstrates good documentation practices per AGENTS.md guidelines.

Summary

This PR is ready for merge. It's a minimal, well-tested change that solves the CocoaPods README rendering issue without introducing any risks to the SDK functionality, security, or conventions.

@andygruening andygruening merged commit e45edd9 into master Jun 11, 2026
2 checks passed
@andygruening andygruening deleted the fix-cocoapods-readme-url branch June 11, 2026 06:27
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.

2 participants