Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[docs] Document the env var CONAN_CENTER_BUILD_SERVICE #23052

Closed
wants to merge 5 commits into from
Closed

[docs] Document the env var CONAN_CENTER_BUILD_SERVICE #23052

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d51cc4b
document CONAN_CENTER_BUILD_SERVICE
uilianries Mar 11, 2024
ca84f68
document CONAN_CENTER_BUILD_SERVICE
uilianries Mar 11, 2024
cdf6e33
add Julius comment
uilianries Mar 11, 2024
0b43e03
Update docs/faqs.md
uilianries Mar 11, 2024
f71b5ec
fix typo
uilianries Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/faqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ This section gathers the most common questions from the community related to pac
* [Can we add package which are parts of bigger projects like Boost?](#can-we-add-package-which-are-parts-of-bigger-projects-like-boost)
* [Can I add my project which I will submit to Boost?](#can-i-add-my-project-which-i-will-submit-to-boost)
* [Can I add options that do not affect `package_id` or the package contents](#can-i-add-options-that-do-not-affect-package_id-or-the-package-contents)
* [Can I use full_package_mode for a requirement in my recipe?](#can-i-use-full_package_mode-for-a-requirement-in-my-recipe)<!-- endToc -->
* [Can I use full_package_mode for a requirement in my recipe?](#can-i-use-full_package_mode-for-a-requirement-in-my-recipe)
* [How to detect if running in ConanCenterIndex CI service?](#how-to-detect-if-running-in-conancenterindex-ci-service)<!-- endToc -->

## What is the policy on recipe name collisions?

Expand Down Expand Up @@ -483,3 +484,15 @@ To have more context about it, please, visit issues #11684 and #11022
In summary, we do not recommend `full_package_mode` or any other custom package id mode for requirements on CCI, it will break other PRs soon or later.
Instead, prefer using `shared=True` by default, when needed.
Also, when having a similar situation, do not hesitate in opening an issue explaining your case, and ask for support from the community.

## How to detect if running in ConanCenterIndex CI service?

The environment variable `CONAN_CENTER_BUILD_SERVICE` is set to `1` when running in the ConanCenterIndex CI service.
This can be used to detect if the recipe is being built in the CI service.
Please bear in mind that it's not intended for general use and will be only allowed on a case-by-case basis. So please ask us before adding it to a recipe.

```python
def configure(self):
if os.getenv('CONAN_CENTER_BUILD_SERVICE') is not None:
self.output.info("Running in ConanCenterIndex CI service")
```
Loading