warnings for local-recipes-index - #4297
Open
memsharded wants to merge 2 commits into
Open
Conversation
AbrilRBS
approved these changes
Jul 21, 2026
jcar87
reviewed
Jul 21, 2026
Comment on lines
+23
to
+26
| Using the ``local-recipes-index`` feature from a fork of ``conan-center-index`` Github repository, | ||
| without using a package server or relying on the ConanCenter package server can easily result in | ||
| missing dependencies due to old versions being removed by upstream ``conan-center-index``. The | ||
| recommendations are: |
Contributor
There was a problem hiding this comment.
I would probably tweak wording to make it more "generic" in terms of explaining the pitfalls, but more specific in terms of what happens with Conan Center.
Some suggestions:
- Mention explicity that the git repository at
conan-center-index's main purpose is to feed into theconancenterremote, and the ability to use it as a local-recipes-index is not a goal. - Remove "building binaries from a private conan-center-index fork" from the paragraph above - and instead mention something like "test changes in multiple recipes together without exporting them before hand" (which from memory, I believe was one of the intended uses of local-recipes-index when it comes to operating a fork)
- Clarify, very explicitly, that unlike a remote Conan server, local-recipes-index does not support recipe revisions, but instead the current branch is a snapshot of all versions and revisions visible. This is already mentioned down below, but may be good to mention it here again
- Reword, that when using a local-recipes-index with a fork of
conan-center-index, users must be careful in the two following scenarios:- bringing changes from upstream (
git pull,git merge master,git rebase masteretc) - because versions they rely on may no longer be exportable from master. Here the best mitigation is just to ensure the versions needed by the user are always in the repo, for example, they can always add their versions to a different subfolder (e.g. something other than "all") - which will minimise merge conflicts as the only potential change is "config.yml" in this scenario
- bringing changes from upstream (
- when using the
conancenterremote alongside local-recipes-index, you have two repositories that potentially export the same versions. This may be intentional or not - users need exercise care.
Comment on lines
+28
to
+29
| - Use a package server to store your recipes and binaries built from your fork, and use it to resolve | ||
| dependencies. |
Contributor
There was a problem hiding this comment.
Since it is not possible to upload binary packages to a remote without also uploading the recipes, I would probably just leave this whole section out, as it essential boils down to "if you need binaries, you need a server" therefore, using local-recipes-index AND needing to configure a remote, it is not entirely clear in which scenario local-recipes-index offers an advantage.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.