Skip to content

Commit

Permalink
reorganize the bundle build so that we don't need a Tapir dependency
Browse files Browse the repository at this point in the history
anymore

Here I'm separating the bundle into two groups of projects: the ones
that can build for all Scala versions and the ones that need 2.12+
so that we no longer need to be doing kamon-tapir/publishLocal before
importing Kamon in IntelliJ.
  • Loading branch information
ivantopo committed Jan 26, 2022
1 parent c6ed328 commit d5ce436
Show file tree
Hide file tree
Showing 7 changed files with 179 additions and 125 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ jobs:
with:
java-version: [email protected]
- name: Test
run: sbt -v ";+instrumentation/publishLocal;+core/test;+instrumentation/test;+reporters/test"
run: sbt -v ";+core/test;+instrumentation/test;+reporters/test"
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
# Kamon<img align="right" src="https://raw.githubusercontent.com/kamon-io/kamon.io/279f4d3a658437a5182e10d75aa3d55b811b2836/assets/img/kamon/kamon-icon-light.svg" height="150px" style="padding-left: 20px"/>
# Kamon Telemetry<img align="right" src="https://raw.githubusercontent.com/kamon-io/kamon.io/279f4d3a658437a5182e10d75aa3d55b811b2836/assets/img/kamon/kamon-icon-light.svg" height="150px" style="padding-left: 20px"/>
[![Discord](https://img.shields.io/discord/866301994074243132?label=Join%20the%20Comunity%20on%20Discord)](https://discord.gg/5JuYsDJ7au)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.kamon/kamon-core_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.kamon/kamon-core_2.13)

Kamon is a set of tools for instrumenting applications running on the JVM. The best way to get started is to go to our
official [Get Started Page](https://kamon.io/get-started/) and start instrumenting your applications right away! There
you will also find guides and reference documentation for the core APIs, instrumentation and reporting modules.

# Importing the project into Intellij IDEA
This project has a library dependency on a subproject of itself (`kamon-tapir`).
As a result of that, if you just clone this project and open it in IDEA, it will fail to import it.
First, run `sbt +kamon-tapir/publishLocal` from the console, and then IDEA will be able to import the project.

## Why is this necessary?
Among our instrumented libraries is `Tapir`, which is also the only library we instrument that does not have a scala 2.11 version.
In order to be able to cross publish `kamon-bundle` to all scala versions, while excluding `kamon-tapir` from the 2.11 bundle,
we had to define `kamon-tapir` as a library dependency of `kamon-bundle` (instead of as a subproject).
Kamon Telemetry is a set of libraries for instrumenting applications running on the JVM. With Kamon Telemetry you can
collect metrics, propagate context across threads and services, and get distributed traces automatically. The best way
to get started is following our [installation guides](https://kamon.io/get-started/) and taking it from there. Have fun
with Kamon!

## License

This software is licensed under the Apache 2 license, quoted below.

Copyright © 2013-2019 the kamon project <https://kamon.io/>
Copyright © 2013-2022 the kamon project <https://kamon.io/>

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
Expand Down
Loading

0 comments on commit d5ce436

Please sign in to comment.