Skip to content

Decouple samples from repo dependencies, depend on published library versions instead #299

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

Open
SebastianAigner opened this issue Apr 1, 2025 · 3 comments
Assignees
Labels

Comments

@SebastianAigner
Copy link
Member

Howdy! 🤠

Currently, examples depend on the surrounding project:

implementation(project(":kotlinx-benchmark-runtime"))

This makes them a less useful reference for people trying to figure out how to set up kx.benchmark in their own project than they could potentially be.

Given that there's plenty of people who are quite proficient in Kotlin and want to be able to benchmark their code, but who aren't as comfortable in configuring Gradle, it would be great to have the samples depend on the library versions that are available on Maven Central instead, so that their configurations build.gradle.kts etc are more copy-pastable and usable as direct references.

@fzhinkin fzhinkin added enhancement New feature or request improve documentation labels Apr 3, 2025
@markoeltiger
Copy link

@fzhinkin can you assign it for me please?

@fzhinkin
Copy link
Collaborator

@markoeltiger, sure, it's yours. Sorry for the delay.

@fzhinkin
Copy link
Collaborator

I totally agree that samples should refer to a published artifacts. However, it would be nice to have a way to substitute a custom version of the plugin (and its runtime library) via some Gradle property. It'll allow running examples in CI against the current plugin version and it may help catching some issues earlier (otherwise, it's hard to ensure that examples continue to work with a new version before publishing that version).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants