Skip to content

Conversation

@buenaflor
Copy link
Contributor

@buenaflor buenaflor commented Mar 14, 2023

  • change mavenLocal to mavenCentral
  • added maven central badge
  • fix typos

@buenaflor buenaflor marked this pull request as ready for review March 14, 2023 23:49
@buenaflor buenaflor requested a review from marandaneto March 15, 2023 10:21
build.gradle.kts Outdated
Comment on lines 63 to 64
.replace(kmpRegex, "io.sentry:sentry-kotlin-multiplatform:${project.version}")
.replace(cocoaRegex, "pod(\"Sentry\", \"~> ${Config.Libs.sentryCocoaVersion}\")")
Copy link
Contributor

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.

Copy link
Contributor

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

Copy link
Contributor Author

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

Copy link
Contributor Author

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")`
Copy link
Contributor

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?

Copy link
Contributor Author

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).

@buenaflor buenaflor requested a review from marandaneto March 15, 2023 13:05
@buenaflor buenaflor mentioned this pull request Mar 15, 2023
@buenaflor buenaflor marked this pull request as draft March 16, 2023 08:45
@buenaflor buenaflor marked this pull request as ready for review March 16, 2023 10:22
@buenaflor buenaflor merged commit 4286689 into main Mar 16, 2023
@buenaflor buenaflor deleted the chore/update-readme branch March 16, 2023 10:55
buenaflor added a commit that referenced this pull request Mar 16, 2023
* 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]>
buenaflor added a commit that referenced this pull request Apr 17, 2023
* 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]>
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.

4 participants