Skip to content

Add Conan Building For Development #432

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
wants to merge 62 commits into
base: dev
Choose a base branch
from
Open

Add Conan Building For Development #432

wants to merge 62 commits into from

Conversation

dangell7
Copy link
Collaborator

@dangell7 dangell7 commented Feb 1, 2025

High Level Overview of Change

Context of Change

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (you added tests for code that already exists, or your new feature included in this PR)
  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)
  • Release

API Impact

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change (in general, breaking changes should only impact the next api_version)
  • libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
  • Peer protocol change (must be backward compatible or bump the peer protocol version)

@dangell7 dangell7 changed the title Conan [DO NOT MERGE] Conan Feb 11, 2025
@tequdev
Copy link
Collaborator

tequdev commented Feb 17, 2025

It is currently working fine in my local build.

@dangell7 dangell7 changed the title Conan Add Conan Building For Development Mar 28, 2025
@dangell7 dangell7 changed the title Add Conan Building For Development Add Conan Building For Development [DO NOT MERGE] Mar 31, 2025
@tequdev tequdev linked an issue Apr 11, 2025 that may be closed by this pull request
@dangell7 dangell7 changed the title Add Conan Building For Development [DO NOT MERGE] Add Conan Building For Development Apr 11, 2025
dangell7 and others added 5 commits April 11, 2025 10:45
Make it easy for projects to depend on libxrpl by adding an `ALIAS`
target named `xrpl::libxrpl` for projects to link.

The name was chosen because:

* The current library target is named `xrpl_core`. There is no other
  "non-core" library target against which we need to distinguish the
  "core" library. We only export one library target, and it should just
  be named after the project to keep things simple and predictable.
* Underscores in target or library names are generally discouraged.
* Every target exported in CMake should be prefixed with the project
  name.

By adding an `ALIAS` target, existing consumers who use the `xrpl_core`
target will not be affected.

* In the future, there can be a migration plan to make `xrpl_core` the
  `ALIAS` target (and `libxrpl` the "real" target, which will affect the
  filename of the compiled binary), and eventually remove it entirely.

Also:

* Fix the Conan recipe so that consumers using Conan import a target
  named `xrpl::libxrpl`. This way, every consumer can use the same
  instructions.
* Document the two easiest methods to depend on libxrpl. Both have been
  tested.
* See #4443.
Copy link
Collaborator

@tequdev tequdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make sure that the workflow is successful after clearing the cache once before marge.

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.

Support Conan
4 participants