Skip to content

Commit 462877d

Browse files
committed
Document ci_config.json has_provides key
1 parent 2c2c0a8 commit 462877d

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ name and the value is a dictionary containing with the following keys:
5959
| `debian_packages` | (Optional) List of extra packages that will be installed on Debian-like CI runners. Dependencies that can be provided by other wraps should not be added here because it's better to test that fallbacks work. When running `tools/sanity_checks.py` locally, this list will be printed but not installed. |
6060
| `msys_packages` | (Optional) List of extra packages that will be installed on MSYS CI runners. |
6161
| `python_packages` | (Optional) List of extra Python packages that will be installed on all CI runners. |
62-
| `fatal_warnings` | (Optional) If set to `false` removes --fatal-meson-warning. Use this only when there is no other way to fix the warning. |
62+
| `fatal_warnings` | (Optional) If set to `false` removes `--fatal-meson-warnings`. Use this only when there is no other way to fix the warning. |
63+
| `has_provides` | (Optional) If set to `false`, the project will not be expected to declare any dependency or program names, e.g. for projects that only provide plugins for another project. |
6364
| `skip_dependency_check` | (Optional) List of platform-specific dependency names that are not always provided by the project. |
6465
| `skip_program_check` | (Optional) List of platform-specific program names that are not always provided by the project. |
6566
| `test_options` | (Optional) List of arguments that will be passed to `meson test` command (e.g. `--timeout-multiplier`, `--no-suite`). |

tools/sanity_checks.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ class CiConfigProject(T.TypedDict, total=False):
175175
msys_packages: list[str]
176176
python_packages: list[str]
177177
fatal_warnings: bool
178+
has_provides: bool
178179
skip_dependency_check: list[str]
179180
skip_program_check: list[str]
180181
test_options: list[str]

0 commit comments

Comments
 (0)