-
-
Notifications
You must be signed in to change notification settings - Fork 19
chore: update readme versions #56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
sentry-kotlin-multiplatform/sentry_kotlin_multiplatform.podspec
Outdated
Show resolved
Hide resolved
build.gradle.kts
Outdated
| .replace(kmpRegex, "io.sentry:sentry-kotlin-multiplatform:${project.version}") | ||
| .replace(cocoaRegex, "pod(\"Sentry\", \"~> ${Config.Libs.sentryCocoaVersion}\")") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The project version isn't necessarily published yet.
I believe that using the maven badges with the latest version (similar to sentry-java) and using a placeholder in the versioning is more effective.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option is to use craft to do this and not Gradle during the formatting pipeline.
https://github.com/getsentry/sentry-kotlin-multiplatform/blob/main/scripts/bump-version.sh
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good - I'd like to at least keep the required sentry cocoa sdk version documented for the user
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As sentry-docs needs to be in sync with cocoa version as well, we should do it manually for now getsentry/sentry-docs#6452 (comment)
README.md
Outdated
|
|
||
| If you are targeting Apple platforms (iOS, macOS, watchOS, tvOS), then you need to use CocoaPods to include [Sentry Cocoa](https://github.com/getsentry/sentry-cocoa) into this SDK. | ||
| One way to achieve this is to include the Sentry Cocoa SDK via the Kotlin CocoaPods extension. Be aware that your Sentry Cocoa version has to match the SDK's version. Currently the supported version is `~> 7.21.0` | ||
| One way to achieve this is to include the Sentry Cocoa SDK via the Kotlin CocoaPods extension. Be aware that your Sentry Cocoa version has to match the SDK's version. Currently the supported version is `pod("Sentry", "~> 8.2.0")` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way to do this automatically though? so People install the KMP SDK and that pulls the compatible version of the Cocoa SDK?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not yet unfortunately. Users need to pull in the cocoa sdk dep themselves as KMP afaik only includes the headers in their apple packages so the actual implementation of these headers has to be provided from somewhere else.
that also means that users aren't necessarily tied to using cocoapods. but I haven't tested yet if SPM or Carthage works (theoretically should though).
sentry-kotlin-multiplatform/sentry_kotlin_multiplatform.podspec
Outdated
Show resolved
Hide resolved
* update sdk version * update cocoa version * add updateReadme task * Format code * surround with trycatch when reading the file * Format code * update podspec * use latest placeholder and track cocoa version manually * remove updateReadme from format workflow * re-add make format * replace placeholder * update readme * Update sentry-kotlin-multiplatform/sentry_kotlin_multiplatform.podspec * Update .github/workflows/format.yml --------- Co-authored-by: Sentry Github Bot <[email protected]> Co-authored-by: Manoel Aranda Neto <[email protected]>
* bump cocoa sdk to 8.3.0 and add view hierarchy * feat(craft): kmp configuration in .craft.yml (#54) * add kmp configuration to .craft.yml * change minVersion to 1.2.0 * release: 0.0.1-alpha.2 * bump craft minVersion to 1.2.1 (#55) * change to cocoapods as source * chore: update readme (#56) * update sdk version * update cocoa version * add updateReadme task * Format code * surround with trycatch when reading the file * Format code * update podspec * use latest placeholder and track cocoa version manually * remove updateReadme from format workflow * re-add make format * replace placeholder * update readme * Update sentry-kotlin-multiplatform/sentry_kotlin_multiplatform.podspec * Update .github/workflows/format.yml --------- Co-authored-by: Sentry Github Bot <[email protected]> Co-authored-by: Manoel Aranda Neto <[email protected]> * update sentry cocoa version in README * update pospec and changelog * bump cocoa version to 8.4.0 and use attachViewHierarchy on Android --------- Co-authored-by: getsentry-bot <[email protected]> Co-authored-by: Sentry Github Bot <[email protected]> Co-authored-by: Manoel Aranda Neto <[email protected]>
mavenLocaltomavenCentral