Skip to content
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

Document correct BoM usage #2136

Closed
ppalaga opened this issue Jan 14, 2021 · 0 comments · Fixed by #2474
Closed

Document correct BoM usage #2136

ppalaga opened this issue Jan 14, 2021 · 0 comments · Fixed by #2474
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ppalaga
Copy link
Contributor

ppalaga commented Jan 14, 2021

Issues like #2131 are a clear sign that we are lacking on documentation about dependency management. Let me file a new issue for that.

We should document at least:

  • The easiest and most straightforward option is to use https://code.quarkus.io/ producing a project with the quarkus-universe-bom that aggregates camel-quarkus-bom. This has the advantage that the user does not need to care for the compatibility of the individual artifacts that may potentially come from various independent project. All artifacts managed by quarkus-universe-bom are supposed to work together flawlessly.
  • Using camel-quarkus-bom instead of quarkus-universe-bom: As long as the user does not import any other BoM beyond camel-quarkus-bom, this is an easy and reliable option too. camel-quarkus-bom manages all supported Camel artifacts and it also imports quarkus-bom. This option can be used if the user plans to use only extensions from Quarkus and Camel Quarkus.
  • Combinig camel-quarkus-bom or quarkus-universe-bom with each other manually: take care that you combine compatible versions. camel-quarkus-bom should typically be imported before quarkus-universe-bom - see the next point.
  • Combinig camel-quarkus-bom with any other BoM: think carefully in which order you import them. The order of imports makes up the precedence. This matters for the artifacts managed by both BoMs.
@ppalaga ppalaga added the documentation Improvements or additions to documentation label Jan 14, 2021
@ppalaga ppalaga self-assigned this Apr 13, 2021
ppalaga added a commit to ppalaga/camel-quarkus that referenced this issue Apr 14, 2021
ppalaga added a commit to ppalaga/camel-quarkus that referenced this issue Apr 14, 2021
ppalaga added a commit that referenced this issue Apr 14, 2021
@ppalaga ppalaga added this to the 2.0.0-M1 milestone Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant