From 628fbfec8f8a4ced0218f845a36db985821eba5b Mon Sep 17 00:00:00 2001 From: Chris Mc Date: Tue, 25 Apr 2023 00:22:34 -0700 Subject: [PATCH] (#17199) docs: removed v2_roadmap (updated steps in v2_migration) * docs: removed v2_roadmap (updated steps in v2_migration) * revert: extra changes --- docs/consuming_recipes.md | 5 ++--- docs/v2_linter.md | 2 +- docs/v2_migration.md | 9 ++++++--- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/consuming_recipes.md b/docs/consuming_recipes.md index b0a653026d..a777e97d08 100644 --- a/docs/consuming_recipes.md +++ b/docs/consuming_recipes.md @@ -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, 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, - and ConanCenter is committed in this [roadmap](v2_roadmap.md) as well, and tries to prepare the user base to these - new features in order to ease the migration to new versions. +- **New Conan Version**: Conan keeps evolving and adding new features, and ConanCenter is committed in this + as well, and tries to prepare the user base to these 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 version, sometimes these changes modify some experimental behavior without modifying recipe syntax. diff --git a/docs/v2_linter.md b/docs/v2_linter.md index 1b6930d1a3..3d6e3a3f6b 100644 --- a/docs/v2_linter.md +++ b/docs/v2_linter.md @@ -7,7 +7,7 @@ * [Import ConanFile from `conan`](#import-conanfile-from-conan) * [Import tools from `conan`](#import-tools-from-conan) -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 raise some warnings and errors that should be addressed in order to migrate the recipes to Conan v2. diff --git a/docs/v2_migration.md b/docs/v2_migration.md index 0e2bfb0608..4f42901c4d 100644 --- a/docs/v2_migration.md +++ b/docs/v2_migration.md @@ -1,8 +1,10 @@ # Preparing recipes for Conan 2.0 -Refer to [road to Conan v2](v2_roadmap.md) to know the steps that -will be taken in ConanCenter and this repository to start running -Conan v2 in pull requests. +This is expected for recipes to be updates in each pull request. + +- 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. ## Contents @@ -110,6 +112,7 @@ In ConanCenterIndex this will typically looks like: tool_path = self.conf_info.get("user.pkg:tool") self.run(f"{tool_path} --build") ``` + > **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) > will include the `self.cpp_info.bindirs` which will provide access to the tools in the correct scopes.