@@ -39,7 +39,7 @@ The core CLI:
3939 - ` REPOS_DEBUG=1 ` (if --debug flag was passed)
4040 - ` REPOS_TOTAL_REPOS=28 ` (total repos in config)
4141 - ` REPOS_FILTERED_COUNT=5 ` (repos after filtering)
42- - ` REPOS_CONFIG_FILE=/path/to/your/config .yaml ` (path to config file)
42+ - ` REPOS_CONFIG_FILE=/path/to/your/repos .yaml ` (path to config file)
43436 . Executes ` repos-health prs ` with only plugin-specific args
4444
4545### Using Context Injection in Your Plugin
@@ -174,7 +174,7 @@ Here's a simple example of a health check plugin written in bash:
174174echo " === Repository Health Check ==="
175175
176176# Parse arguments
177- CONFIG_FILE=" config .yaml"
177+ CONFIG_FILE=" repos .yaml"
178178VERBOSE=false
179179
180180while [[ $# -gt 0 ]]; do
@@ -222,7 +222,7 @@ import sys
222222
223223def main ():
224224 parser = argparse.ArgumentParser(description = ' Security audit for repositories' )
225- parser.add_argument(' -c' , ' --config' , default = ' config .yaml' , help = ' Config file path' )
225+ parser.add_argument(' -c' , ' --config' , default = ' repos .yaml' , help = ' Config file path' )
226226 parser.add_argument(' --fix' , action = ' store_true' , help = ' Attempt to fix issues automatically' )
227227 args = parser.parse_args()
228228
@@ -291,7 +291,7 @@ Examples:
291291repos health
292292
293293# Run health check with custom config and verbose output
294- repos health -c my-config .yaml -v
294+ repos health -c my-repos .yaml -v
295295
296296# Run security audit
297297repos security --config production.yaml
@@ -324,7 +324,7 @@ repos security --fix
324324
325325### Integration
326326
327- - Plugins should work with the standard ` config .yaml` format
327+ - Plugins should work with the standard ` repos .yaml` format
328328- Parse the YAML configuration to access repository information
329329- Consider the repository structure (name, path, tags, etc.)
330330
@@ -338,14 +338,14 @@ Most plugins will need to read the repos configuration file. Here's how to parse
338338
339339``` bash
340340# Install yq: brew install yq (macOS) or similar
341- repos=$( yq eval ' .repositories[].name' config .yaml)
341+ repos=$( yq eval ' .repositories[].name' repos .yaml)
342342```
343343
344344** Python:**
345345
346346``` python
347347import yaml
348- with open (' config .yaml' , ' r' ) as f:
348+ with open (' repos .yaml' , ' r' ) as f:
349349 config = yaml.safe_load(f)
350350 repositories = config.get(' repositories' , [])
351351```
@@ -356,7 +356,7 @@ with open('config.yaml', 'r') as f:
356356use serde_yaml;
357357use std :: fs;
358358
359- let content = fs :: read_to_string (" config .yaml" )? ;
359+ let content = fs :: read_to_string (" repos .yaml" )? ;
360360let config : serde_yaml :: Value = serde_yaml :: from_str (& content )? ;
361361```
362362
0 commit comments