Sponsored Content
Skip to content

docs: Update instructions how to (re)generate conan.lock file - #6070

Merged
bthomee merged 6 commits into
developfrom
bthomee/lockfile
Nov 26, 2025
Merged

docs: Update instructions how to (re)generate conan.lock file#6070
bthomee merged 6 commits into
developfrom
bthomee/lockfile

Conversation

@bthomee

@bthomee bthomee commented Nov 22, 2025

Copy link
Copy Markdown
Collaborator

High Level Overview of Change

This change updates the instructions for how to generate a Conan lockfile that is compatible with Linux, macOS, and Windows.

Context of Change

Whenever Conan dependencies change, the Conan lock file needs to be regenerated. However, different OSes have slightly different requirements, and thus require slightly different dependencies. Luckily a single conan.lock file can be used, as long as the union of dependencies is included.

The current instructions in the BUILD.md file are insufficient to regenerate the lock file such that it is compatible with all OSes, which this change addresses. The three profiles contain the bare minimum needed to generate the lockfile; it does not particularly matter whether the build type is Debug or Release, for instance.

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)
  • Performance (increase or change in throughput and/or latency)
  • 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

@bthomee
bthomee requested a review from mathbunnyru November 22, 2025 16:24
@bthomee bthomee added the Trivial Simple change with minimal effect, or already tested. Only needs one approval. label Nov 22, 2025
@codecov

codecov Bot commented Nov 22, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.6%. Comparing base (8564702) to head (05c35a1).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           develop   #6070     +/-   ##
=========================================
- Coverage     78.6%   78.6%   -0.0%     
=========================================
  Files          818     818             
  Lines        68938   68938             
  Branches      8241    8241             
=========================================
- Hits         54166   54163      -3     
- Misses       14772   14775      +3     

see 4 files with indirect coverage changes

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread conan/lockfile/linux.profile
Comment thread conan/lockfile/macos.profile Outdated
Comment thread conan/lockfile/README.md
Comment thread conan/lockfile/README.md Outdated
Comment thread BUILD.md Outdated
Comment thread conan/lockfile/README.md Outdated
Comment thread conan/lockfile/README.md Outdated
Comment thread conan/lockfile/macos.profile
@bthomee
bthomee enabled auto-merge (squash) November 26, 2025 17:04
@bthomee
bthomee merged commit a18b30b into develop Nov 26, 2025
3 checks passed
@bthomee
bthomee deleted the bthomee/lockfile branch November 26, 2025 17:28
@mvadari mvadari added this to the 3.2.0 milestone May 20, 2026
beartec-jpg pushed a commit to beartec-jpg/FalconLedger that referenced this pull request Jun 1, 2026
…6070)

This change updates the instructions for how to generate a Conan lockfile that is compatible with Linux, macOS, and Windows.

Whenever Conan dependencies change, the Conan lock file needs to be regenerated. However, different OSes have slightly different requirements, and thus require slightly different dependencies. Luckily a single `conan.lock` file can be used, as long as the union of dependencies is included.

The current instructions in the `BUILD.md` file are insufficient to regenerate the lock file such that it is compatible with all OSes, which this change addresses. The three profiles contain the bare minimum needed to generate the lockfile; it does not particularly matter whether the build type is Debug or Release, for instance.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Trivial Simple change with minimal effect, or already tested. Only needs one approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants