Skip to content

feat: add ci, release notes, and jazzy docs workflow - #36

Merged
vpeschenkov merged 13 commits into
masterfrom
pr/docs-ci-release-notes
Jun 15, 2026
Merged

feat: add ci, release notes, and jazzy docs workflow#36
vpeschenkov merged 13 commits into
masterfrom
pr/docs-ci-release-notes

Conversation

@vpeschenkov

@vpeschenkov vpeschenkov commented Jun 15, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add GitHub Actions CI and release notes updates from this branch
  • Add Jazzy documentation generation workflow on push
  • Run Jazzy through Bundler and lock Ruby dependencies
  • Remove Objective-C compatibility remnants: ObjC example app, umbrella header, @objc annotations, NSObject inheritance, and ObjC CI steps

Testing

  • sh -n scripts/generate_docs.sh
  • ruby -e 'require "yaml"; YAML.load_file(".github/workflows/docs.yml"); puts "ok"'
  • git diff --check -- Gemfile scripts/generate_docs.sh
  • swift package dump-package
  • xcodebuild test -project LetterAvatarKit.xcodeproj -scheme LetterAvatarKit -destination 'platform=iOS Simulator,name=iPhone 16,OS=18.6'
  • xcodebuild build -project LetterAvatarKitExample/LetterAvatarKitExample.xcodeproj -scheme LetterAvatarKitExample -destination 'platform=iOS Simulator,name=iPhone 16,OS=18.6'

Note: local docs generation via ./scripts/generate_docs.sh was not completed in this environment before the Bundler workflow update because jazzy was not available globally.

@vpeschenkov vpeschenkov changed the title Add CI, release notes, and Jazzy docs workflow Add CI, docs workflow, and remove ObjC remnants Jun 15, 2026
@vpeschenkov vpeschenkov changed the title Add CI, docs workflow, and remove ObjC remnants feat: add ci, release notes, and jazzy docs workflow Jun 15, 2026
vpeschenkov and others added 7 commits June 16, 2026 00:41
…notes

# Conflicts:
#	.github/workflows/ci.yml
#	LetterAvatarKitObjcExample/LetterAvatarKitObjcExample.xcodeproj/project.pbxproj
#	LetterAvatarKitObjcExample/Podfile
#	LetterAvatarKitObjcExample/Podfile.lock
#	LetterAvatarKitObjcExample/Pods/Local Podspecs/LetterAvatarKit.podspec.json
#	LetterAvatarKitObjcExample/Pods/Manifest.lock
#	LetterAvatarKitObjcExample/Pods/Pods.xcodeproj/project.pbxproj
#	LetterAvatarKitObjcExample/Pods/Target Support Files/LetterAvatarKit/LetterAvatarKit-Info.plist
#	LetterAvatarKitObjcExample/Pods/Target Support Files/Pods-LetterAvatarKitObjcExample/Pods-LetterAvatarKitObjcExample-Info.plist
#	LetterAvatarKitObjcExample/Pods/Target Support Files/Pods-LetterAvatarKitObjcExample/Pods-LetterAvatarKitObjcExample-frameworks.sh
#	LetterAvatarKitObjcExample/Pods/Target Support Files/Pods-LetterAvatarKitObjcExample/Pods-LetterAvatarKitObjcExample.debug.xcconfig
#	LetterAvatarKitObjcExample/Pods/Target Support Files/Pods-LetterAvatarKitObjcExample/Pods-LetterAvatarKitObjcExample.release.xcconfig
@vpeschenkov
vpeschenkov merged commit 0a73593 into master Jun 15, 2026
@vpeschenkov
vpeschenkov deleted the pr/docs-ci-release-notes branch June 15, 2026 23:00
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.

1 participant