ericLemanissier/conan-center-index
1
0
Fork 1
mirror of https://github.com/conan-io/conan-center-index.git synced 2025-08-13 01:50:42 +00:00
Code Issues 6 Packages Projects Releases Wiki Activity

(#17199) docs: removed v2_roadmap (updated steps in v2_migration)

Browse Source 
* docs: removed v2_roadmap (updated steps in v2_migration)

* revert: extra changes
This commit is contained in:
Chris Mc
2023-04-25 00:22:34 -07:00
committed by GitHub
parent d0ce881bda
commit 628fbfec8f
3 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/consuming_recipes.md
View File

@@ -23,9 +23,8 @@ There can be several causes if a recipe (a new revision) might stopped to work i
If your Conan client is not new enough, If your Conan client is not new enough,
Conan will fail to parse the recipe and will raise a cryptic Python syntax error. Conan will fail to parse the recipe and will raise a cryptic Python syntax error.
- **New Conan Version**: Conan keeps evolving and adding new features, especially on its road to Conan 2.0, - **New Conan Version**: Conan keeps evolving and adding new features, and ConanCenter is committed in this
and ConanCenter is committed in this [roadmap](v2_roadmap.md) as well, and tries to prepare the user base to these as well, and tries to prepare the user base to these new features in order to ease the migration to new versions.
new features in order to ease the migration to new versions.
New recipe revisions can take into account changes that are introduced in new Conan client New recipe revisions can take into account changes that are introduced in new Conan client
version, sometimes these changes modify some experimental behavior without modifying recipe syntax. version, sometimes these changes modify some experimental behavior without modifying recipe syntax.

2
docs/v2_linter.md
View File

@@ -7,7 +7,7 @@
* [Import ConanFile from `conan`](#import-conanfile-from-conan) * [Import ConanFile from `conan`](#import-conanfile-from-conan)
* [Import tools from `conan`](#import-tools-from-conan)<!-- endToc --> * [Import tools from `conan`](#import-tools-from-conan)<!-- endToc -->
On our [path to Conan v2](v2_roadmap.md) we are leveraging on custom Pylint rules. This We are leveraging on custom Pylint rules. This
linter will run for every pull-request that is submitted to the repository and will linter will run for every pull-request that is submitted to the repository and will
raise some warnings and errors that should be addressed in order to migrate the raise some warnings and errors that should be addressed in order to migrate the
recipes to Conan v2. recipes to Conan v2.

9
docs/v2_migration.md
View File

@@ -1,8 +1,10 @@
# Preparing recipes for Conan 2.0 # Preparing recipes for Conan 2.0
Refer to [road to Conan v2](v2_roadmap.md) to know the steps that This is expected for recipes to be updates in each pull request.
will be taken in ConanCenter and this repository to start running
Conan v2 in pull requests. - Updated helpers are expected, this is enforced by the [v2_linter](v2_linter.md)
- Once a recipe publishes v2 packages, it must pass the v2 pipeline
- The v2 pipeline with **shortly be required** for changes to be merged.
<!-- toc --> <!-- toc -->
## Contents ## Contents
@@ -110,6 +112,7 @@ In ConanCenterIndex this will typically looks like:
tool_path = self.conf_info.get("user.pkg:tool") tool_path = self.conf_info.get("user.pkg:tool")
self.run(f"{tool_path} --build") self.run(f"{tool_path} --build")
``` ```
> **Note**: This should only be used when absolutely required. In the vast majority of cases, the new > **Note**: This should only be used when absolutely required. In the vast majority of cases, the new
> ["Environments"](https://docs.conan.io/1/reference/conanfile/tools/env/environment.html?highlight=Virtual) > ["Environments"](https://docs.conan.io/1/reference/conanfile/tools/env/environment.html?highlight=Virtual)
> will include the `self.cpp_info.bindirs` which will provide access to the tools in the correct scopes. > will include the `self.cpp_info.bindirs` which will provide access to the tools in the correct scopes.