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.

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

doc: add new schema entry for the bot static lib updates #2253

Merged
merged 7 commits into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 15 additions & 1 deletion conda_smithy/data/conda-forge.json
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,19 @@
}
],
"description": "Bot config for version update PRs"
},
"update_static_libs": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"description": "Update packages in `host` that are used for static linking. For bot to issue update PRs, you must have both an abstract specification of the library (e.g., `llvmdev 15.0.*`) and a concrete specification (e.g., `llvmdev 15.0.7 *_5`). The bot will find the latest package that satisfies the abstract specification and update the concrete specification to this latest package.",
"title": "Update Static Libs"
}
},
"title": "BotConfig",
Expand Down Expand Up @@ -825,6 +838,7 @@
"type": "string"
},
"Nullable": {
"const": null,
"description": "Created to avoid issue with schema validation of null values in lists or dicts.",
"enum": [
null
Expand Down Expand Up @@ -1973,7 +1987,7 @@
"type": "null"
}
],
"description": "The `provider` field is a mapping from build platform (not target platform)\nto CI service. It determines which service handles each build platform.\nIf a desired build platform is not available with a selected provider\n(either natively or with emulation), the build will be disabled.\nUse the `build_platform` field to manually specify cross-compilation when\nno providers offer a desired build platform.\n\nThe following are available as supported build platforms:\n\n* `linux_64`\n* `osx_64`\n* `win_64`\n* `linux_aarch64`\n* `linux_ppc64le`\n* `linux_s390x`\n* `linux_armv7l`\n\nThe following CI services are available:\n\n* `azure`\n* `circle`\n* `travis`\n* `appveyor`\n* `None` or `False` to disable a build platform.\n* `default` to choose an appropriate CI (only if available)\n* `native` to choose an appropriate CI for native compiling (only if available)\n* `emulated` to choose an appropriate CI for compiling inside an emulation\n of the target platform (only if available)\n\nFor example, switching linux_64 & osx_64 to build on Travis CI, with win_64 on\nAppveyor:\n\n```yaml\nprovider:\n linux_64: travis\n osx_64: travis\n win_64: appveyor\n```\n\nCurrently, x86_64 platforms are enabled, but other build platforms are\ndisabled by default. i.e. an empty provider entry is equivalent to the\nfollowing:\n\n```yaml\nprovider:\n linux_64: azure\n osx_64: azure\n win_64: azure\n linux_ppc64le: None\n linux_aarch64: None\n```\n\nTo enable `linux_ppc64le` and `linux_aarch64` add the following:\n\n```yaml\nprovider:\n linux_ppc64le: default\n linux_aarch64: default\n```"
"description": "The `provider` field is a mapping from build platform (not target platform)\nto CI service. It determines which service handles each build platform.\nIf a desired build platform is not available with a selected provider\n(either natively or with emulation), the build will be disabled.\nUse the `build_platform` field to manually specify cross-compilation when\nno providers offer a desired build platform.\n\nThe following are available as supported build platforms:\n\n* `linux_64`\n* `osx_64`\n* `win_64`\n* `linux_aarch64`\n* `linux_ppc64le`\n* `linux_s390x`\n* `linux_armv7l`\n\nThe following CI services are available:\n\n* `azure`\n* `circle`\n* `travis`\n* `appveyor`\n* `None` or `False` to disable a build platform.\n* `default` to choose an appropriate CI (only if available)\n* `native` to choose an appropriate CI for native compiling (only if available)\n* `emulated` to choose an appropriate CI for compiling inside an emulation\n of the target platform (only if available)\n\nFor example, making explicit that linux_64 & osx_64 build on azure (by default),\nand switching win_64 to Appveyor:\n\n```yaml\nprovider:\n linux_64: azure\n osx_64: azure\n win_64: appveyor\n```\n\nCurrently, x86_64 platforms are enabled, but other build platforms are\ndisabled by default. i.e. an empty provider entry is equivalent to the\nfollowing:\n\n```yaml\nprovider:\n linux_64: azure\n osx_64: azure\n win_64: azure\n linux_ppc64le: None\n linux_aarch64: None\n```\n\nTo enable `linux_ppc64le` and `linux_aarch64` add the following:\n\n```yaml\nprovider:\n linux_ppc64le: default\n linux_aarch64: default\n```"
},
"package": {
"anyOf": [
Expand Down
1 change: 1 addition & 0 deletions conda_smithy/data/conda-forge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ bot:
check_solvable: true
inspection: hint
run_deps_from_wheel: false
update_static_libs: false
version_updates:
exclude: []
random_fraction_to_keep: null
Expand Down
11 changes: 11 additions & 0 deletions conda_smithy/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,17 @@ class BotConfig(BaseModel):
description="Bot config for version update PRs",
)

update_static_libs: Optional[bool] = Field(
default=False,
description="Update packages in `host` that are used for static "
"linking. For bot to issue update PRs, you must have both an "
"abstract specification of the library (e.g., `llvmdev 15.0.*`) "
"and a concrete specification (e.g., `llvmdev 15.0.7 *_5`). The "
"bot will find the latest package that satisfies the abstract "
"specification and update the concrete specification to this "
"latest package.",
)


class CondaBuildConfig(BaseModel):
model_config: ConfigDict = ConfigDict(extra="allow")
Expand Down
23 changes: 23 additions & 0 deletions news/2253-bot-config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Added documentation for new bot option ``update_static_libs``. (#2253)

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>