Skip to content

docs: add publishing guide - #35

Merged
taylanpince merged 1 commit into
masterfrom
add-publishing-guide
Jun 8, 2026
Merged

taylanpince merged 1 commit into
masterfrom
add-publishing-guide

Conversation

@tolgahan-arikan

Copy link
Copy Markdown
Collaborator

Summary

  • add a dedicated Publishing guide for release PRs, tags, SPM availability, and CocoaPods trunk publishing
  • link the guide from the bottom of README.md

Changes

  • Moved the release process out of README.md into publishing.md
  • Included the PR Prepare 0.1.0-alpha.1 release #23 post-merge checks for public source visibility, tag verification, trunk auth, pod ownership, and CocoaPods non-overwrite behavior

Testing

  • swift build passes
  • swift test passes
  • pod lib lint oms-client-swift-sdk.podspec --swift-version=6.0 --platforms=ios,macos passes
  • git diff --check passes
  • Demo app builds (xcodebuild -project Examples/sdk-demo/oms-sdk-demo.xcodeproj -scheme oms-sdk-demo build) — not applicable; docs only

Related

@tolgahan-arikan
tolgahan-arikan requested a review from a team June 8, 2026 15:34
@claude

claude Bot commented Jun 8, 2026 •

Copy link
Copy Markdown

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


Code Review Complete

Reviewing this publishing guide PR against OMS SDK conventions:

Todo List:

  • Read and analyze the changed files
  • Review against AGENTS.md conventions
  • Check for security considerations
  • Verify shell command quoting for paths with spaces
  • Check platform availability requirements
  • Provide comprehensive review feedback

Review Summary

This is an excellent documentation contribution that successfully extracts the release process from README.md into a dedicated publishing guide. The content is comprehensive and follows the repository's conventions.

✅ Positives

  1. Proper path quoting: All shell commands correctly quote paths with spaces (e.g., Examples/sdk-demo/oms-sdk-demo.xcodeproj)
  2. Comprehensive workflow: Covers the complete release process from branching to CocoaPods publishing
  3. Clear step-by-step format: Well-organized with numbered steps and code blocks
  4. Security awareness: Includes proper checks for public repository access before CocoaPods publishing
  5. Validation steps: Includes all required build/test validation commands from AGENTS.md
  6. Proper linking: README.md correctly links to the new guide

📝 Minor Suggestions

  1. Line 34: The demo app build command could benefit from a note about when it's needed:

    # Only if demo app code changed in this release
    xcodebuild -project Examples/sdk-demo/oms-sdk-demo.xcodeproj -scheme oms-sdk-demo build
  2. Line 66: Consider adding a brief explanation of why the tag verification is important:

    # Verify the tag is accessible from the public GitHub repository
    GIT_TERMINAL_PROMPT=0 git -c credential.helper= ls-remote --exit-code https://github.com/0xsequence/swift-sdk.git "refs/tags/$VERSION"

Security & Compliance ✅

  • ✅ No private key material handling (N/A - documentation only)
  • ✅ No floating-point math for tokens (N/A - documentation only)
  • ✅ No platform availability concerns (N/A - documentation only)
  • ✅ All shell commands properly quote paths with spaces
  • ✅ Security-conscious approach to CocoaPods publishing (checks public repo access)

Testing ✅

  • ✅ No new behavior to test (documentation only)
  • ✅ Author has verified swift build, swift test, and podspec validation pass
  • ✅ Correctly excludes demo app build test as "not applicable"

The publishing guide is well-written, follows repository conventions, and provides valuable guidance for release management. The extraction from README.md to a dedicated file improves documentation organization without any technical issues.

Recommendation: ✅ Approve

@taylanpince
taylanpince merged commit b7e9f98 into master Jun 8, 2026
2 checks passed
@tolgahan-arikan
tolgahan-arikan deleted the add-publishing-guide branch June 10, 2026 12:29
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