https://github.com/axonframework/axon-bom
Axon Bill of Materials (BOM) - provides managed dependencies for all Axon artifacts
https://github.com/axonframework/axon-bom
axon axon-framework axonframework billofmaterials bom
Last synced: 8 months ago
JSON representation
Axon Bill of Materials (BOM) - provides managed dependencies for all Axon artifacts
- Host: GitHub
- URL: https://github.com/axonframework/axon-bom
- Owner: AxonFramework
- License: apache-2.0
- Created: 2021-01-07T10:00:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-14T11:32:13.000Z (8 months ago)
- Last Synced: 2025-02-14T12:34:09.753Z (8 months ago)
- Topics: axon, axon-framework, axonframework, billofmaterials, bom
- Homepage:
- Size: 354 KB
- Stars: 15
- Watchers: 10
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Axon Bill of Materials
[](https://maven-badges.herokuapp.com/maven-central/org.axonframework/axon-bom)
This project provides Maven managed dependencies for all Axon artifacts.
Using `axon-bom` inside a dependency management system ensures the compatibility of Axon's dependencies.
At this stage, the BOM includes the dependencies for the following projects:
* [Axon Framework](https://github.com/AxonFramework/AxonFramework)
* [Axon Server Connector Java](https://github.com/AxonIQ/axonserver-connector-java)
* [Axon Framework AMQP Extension](https://github.com/AxonFramework/extension-amqp)
* [Axon Framework CDI Extension](https://github.com/AxonFramework/extension-cdi)
* [Axon Framework JGroups Extension](https://github.com/AxonFramework/extension-jgroups)
* [Axon Framework JobRunr Pro Extension](https://github.com/AxonFramework/extension-jobrunrpro)
* [Axon Framework Kafka Extension](https://github.com/AxonFramework/extension-kafka)
* [Axon Framework Kotlin Extension](https://github.com/AxonFramework/extension-kotlin)
* [Axon Framework Mongo Extension](https://github.com/AxonFramework/extension-mongo)
* [Axon Framework Multi-Tenancy Extension](https://github.com/AxonFramework/extension-multitenancy)
* [Axon Framework Reactor Extension](https://github.com/AxonFramework/extension-reactor)
* [Axon Framework Spring Ahead of Time Extension](https://github.com/AxonFramework/extension-spring-aot)
* [Axon Framework Spring Cloud Extension](https://github.com/AxonFramework/extension-springcloud)
* [Axon Framework Tracing Extension](https://github.com/AxonFramework/extension-tracing)
The Bill of Materials always follows at least the Axon Framework release cycle.
So every new Axon Framework version will lead to a new Bill of Materials version.
Releases of other dependencies may or may not lead to a new release.
## Getting Started - Maven
For usage with [Maven](https://maven.apache.org/), import the BOM in your project like so:
```xml
...
org.axonframework
axon-bom
${version.axon}
pom
import
...
...
```
Then add the dependencies you need without specifying the version:
```xml
...
org.axonframework
axon-configuration
org.axonframework
axon-server-connector
org.axonframework.extensions.kafka
axon-kafka
org.axonframework.extensions.mongo
axon-mongo
...
...
```
## Getting Started - Gradle
For usage with **[Gradle](https://gradle.org/) up to version 4.x**, apply the `dependency-management-plugin` plugin like so:
```groovy
buildscript {
repositories {
jcenter()
}
dependencies {
classpath "io.spring.gradle:dependency-management-plugin:0.5.1.RELEASE"
}
}
apply plugin: "io.spring.dependency-management"
```
After this, import the Axon BOM:
```groovy
dependencyManagement {
imports {
mavenBom 'org.axonframework:axon-bom:'
}
}
```
Then add the dependencies you need without specifying the version:
```groovy
dependencies {
compile 'org.axonframework:axon-configuration'
compile 'org.axonframework:axon-server-connector'
compile 'org.axonframework.extensions.kafka:axon-kafka'
compile 'org.axonframework.extensions.mongo:axon-mongo'
...
}
```
Beginning with **[Gradle version 5.0](https://docs.gradle.org/5.0/userguide/managing_transitive_dependencies.html#sec:bom_import)**, you can also omit the dependency-management plugin and instead use the `platform` dependency dsl to import maven boms:
```
implementation(platform("org.axonframework:axon-bom:"))
```
## Receiving help
Are you having trouble using the bill of material or any of the contained dependencies?
We'd like to help you out the best we can!
There are a couple of things to consider when you're traversing anything Axon:
* Checking the [reference guide](https://docs.axoniq.io) should be your first stop,
as the majority of possible scenarios you might encounter when using Axon should be covered there.
* If the Reference Guide does not cover a specific topic you would've expected,
we'd appreciate if you could file an [issue](https://github.com/AxonIQ/reference-guide/issues) about it for us.
* There is a [forum](https://discuss.axoniq.io/) to support you in the case the reference guide did not sufficiently answer your question.
Axon Framework and Server developers will help out on a best effort basis.
Know that any support from contributors on posted question is very much appreciated on the forum.
* Next to the forum we also monitor Stack Overflow for any questions which are tagged with `axon`.
## Feature requests and issue reporting
We use GitHub's [issue tracking system](https://github.com/AxonFramework/axon-bom/issues) for new feature request,
framework enhancements and bugs.
Prior to filing an issue, please verify that it's not already reported by someone else.
When filing bugs:
* A description of your setup and what's happening helps us to figure out what the issue might be
* Do not forget to provide the framework version you're using
* If possible, share a stack trace, using the Markdown semantic ```
When filing features:
* A description of the envisioned addition or enhancement should be provided
* (Pseudo-)Code snippets showing what it might look like help us understand your suggestion better
* If you have any thoughts on where to plug this into the framework, that would be very helpful too
* Lastly, we value contributions to the framework highly. So please provide a Pull Request as well!