Skip to content

Commit 9ea3e18

Browse files
authored
refactor: rename config.yaml with repos.yaml (#150)
1 parent b93d0c4 commit 9ea3e18

File tree

20 files changed

+83
-83
lines changed

20 files changed

+83
-83
lines changed

.dockerignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ docs/
1717
target/
1818

1919
# Local configs and data
20-
config.yaml
20+
repos.yaml
2121
cloned_repos/
2222
logs/
2323

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ cloned_repos*/
2929
coverage/
3030
*.profraw
3131
logs/
32-
config.yaml
32+
repos.yaml
3333
tarpaulin-report.html
3434
test-*/
3535
tests/test-recipes.yaml

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ engineers working with complex microservice architectures.
2121
## Features
2222

2323
- **Centralized Repository Management**: Define all your repositories in a
24-
single, easy-to-manage `config.yaml` file.
24+
single, easy-to-manage `repos.yaml` file.
2525
- **Tag-Based Filtering**: Assign tags to your repositories and use them to run
2626
commands on specific subsets of your projects (e.g., `backend`, `frontend`,
2727
`java`, `rust`).
@@ -113,7 +113,7 @@ for you.
113113

114114
2. **Generate the config file**:
115115
Run `repos init` in the `my-projects` directory. It will scan for Git
116-
repositories and create a `config.yaml` file.
116+
repositories and create a `repos.yaml` file.
117117

118118
```bash
119119
repos init
@@ -139,7 +139,7 @@ overview. Click on a command to see its detailed documentation.
139139
| [**`run`**](./docs/commands/run.md) | Runs a shell command or a pre-defined recipe in each repository. |
140140
| [**`pr`**](./docs/commands/pr.md) | Creates pull requests for repositories with changes. |
141141
| [**`rm`**](./docs/commands/rm.md) | Removes cloned repositories from your local disk. |
142-
| [**`init`**](./docs/commands/init.md) | Generates a `config.yaml` file from local Git repositories. |
142+
| [**`init`**](./docs/commands/init.md) | Generates a `repos.yaml` file from local Git repositories. |
143143
| [**`validate`**](./plugins/repos-validate/README.md) | Validates config file, repository connectivity, and synchronizes topics (via plugin). |
144144
| [**`review`**](./plugins/repos-review/README.md) | Uses UI to review changes (via plugin). |
145145
| [**`fix`**](./plugins/repos-fix/README.md) | Automatically fixes bugs based on JIRA tickets using Cursor AI (via plugin). |
@@ -148,7 +148,7 @@ For a full list of options for any command, run `repos <COMMAND> --help`.
148148

149149
## Configuration
150150

151-
The `config.yaml` file is the heart of `repos`. It defines your repositories and
151+
The `repos.yaml` file is the heart of `repos`. It defines your repositories and
152152
their metadata.
153153

154154
```yaml

docs/commands/clone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# repos clone
22

3-
The `clone` command clones repositories specified in your `config.yaml` file
3+
The `clone` command clones repositories specified in your `repos.yaml` file
44
into your local workspace.
55

66
## Usage
@@ -24,7 +24,7 @@ repositories defined in the config.
2424
## Options
2525

2626
- `-c, --config <CONFIG>`: Specifies the path to the configuration file.
27-
Defaults to `config.yaml`.
27+
Defaults to `repos.yaml`.
2828
- `-t, --tag <TAG>`: Filters repositories to clone only those that have the
2929
specified tag. This option can be used multiple times to include repositories
3030
with *any* of the specified tags (OR logic).

docs/commands/init.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# repos init
22

33
The `init` command scans your local filesystem for Git repositories and
4-
generates a `config.yaml` file from them.
4+
generates a `repos.yaml` file from them.
55

66
## Usage
77

@@ -12,14 +12,14 @@ repos init [OPTIONS]
1212
## Description
1313

1414
This command is the easiest way to get started with `repos`. Instead of writing
15-
a `config.yaml` file by hand, you can clone your repositories into a directory
15+
a `repos.yaml` file by hand, you can clone your repositories into a directory
1616
and then run `repos init` to automatically generate the configuration. It will
1717
discover all Git repositories in the current directory and its subdirectories.
1818

1919
## Options
2020

2121
- `-o, --output <OUTPUT>`: Specifies the name of the output configuration file.
22-
Defaults to `config.yaml`.
22+
Defaults to `repos.yaml`.
2323
- `--overwrite`: If a configuration file already exists at the output path, this
2424
flag allows `repos` to overwrite it.
2525
- `--supplement`: If a configuration file already exists, this flag will add
@@ -42,7 +42,7 @@ git clone https://github.com/owner/project-two.git
4242
repos init
4343
```
4444

45-
This will create a `config.yaml` file in the `my-projects` directory.
45+
This will create a `repos.yaml` file in the `my-projects` directory.
4646

4747
### Generate a config with a custom name
4848

@@ -58,12 +58,12 @@ repos init --overwrite
5858

5959
### Add new repositories to an existing config
6060

61-
If you have an existing `config.yaml` and have cloned new repositories, you can
61+
If you have an existing `repos.yaml` and have cloned new repositories, you can
6262
add them without losing your existing configuration (including tags, custom
6363
paths, etc.).
6464

6565
```bash
66-
# config.yaml already exists
66+
# repos.yaml already exists
6767
git clone https://github.com/owner/new-project.git
6868
repos init --supplement
6969
```

docs/commands/ls.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# repos ls
22

3-
The `ls` command lists repositories specified in your `config.yaml` file with
3+
The `ls` command lists repositories specified in your `repos.yaml` file with
44
optional filtering capabilities.
55

66
## Usage
@@ -28,7 +28,7 @@ repositories defined in the config.
2828
## Options
2929

3030
- `-c, --config <CONFIG>`: Specifies the path to the configuration file.
31-
Defaults to `config.yaml`.
31+
Defaults to `repos.yaml`.
3232
- `-t, --tag <TAG>`: Filters repositories to list only those that have the
3333
specified tag. This option can be used multiple times to include repositories
3434
with *any* of the specified tags (OR logic).
@@ -114,7 +114,7 @@ repos clone --tag flow
114114
### Use with custom config
115115

116116
```bash
117-
repos ls --config path/to/custom-config.yaml
117+
repos ls --config path/to/custom-repos.yaml
118118
```
119119

120120
## Use Cases

docs/commands/pr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ the `GITHUB_TOKEN` environment variable.
4343
- `--create-only`: A "dry-run" mode. It prepares the PR but does not create it
4444
on GitHub.
4545
- `-c, --config <CONFIG>`: Path to the configuration file. Defaults to
46-
`config.yaml`.
46+
`repos.yaml`.
4747
- `-t, --tag <TAG>`: Filter repositories by tag. Can be specified multiple
4848
times.
4949
- `-e, --exclude-tag <EXCLUDE_TAG>`: Exclude repositories with a specific tag.

docs/commands/rm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If not provided, filtering will be based on tags.
2222
## Options
2323

2424
- `-c, --config <CONFIG>`: Path to the configuration file. Defaults to
25-
`config.yaml`.
25+
`repos.yaml`.
2626
- `-t, --tag <TAG>`: Filter repositories to remove only those with the specified
2727
tag. Can be used multiple times.
2828
- `-e, --exclude-tag <EXCLUDE_TAG>`: Exclude repositories with a specific tag

docs/commands/run.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ tasks across hundreds or thousands of repositories at once. You can run any
2424
shell command, from simple `ls` to complex `docker build` scripts.
2525

2626
Additionally, you can define **recipes**—multi-step scripts—in your
27-
`config.yaml` and execute them by name using the `--recipe` option. This is
27+
`repos.yaml` and execute them by name using the `--recipe` option. This is
2828
perfect for standardizing complex workflows like dependency updates, code
2929
generation, or release preparation.
3030

@@ -41,7 +41,7 @@ command in. If not provided, filtering will be based on tags.
4141
## Options
4242

4343
- `-c, --config <CONFIG>`: Path to the configuration file. Defaults to
44-
`config.yaml`.
44+
`repos.yaml`.
4545
- `-r, --recipe <RECIPE_NAME>`: The name of the recipe to run. This option is
4646
mutually exclusive with the `COMMAND` argument.
4747
- `-t, --tag <TAG>`: Filter repositories by tag. Can be specified multiple times
@@ -57,12 +57,12 @@ instead of the default `output/runs`.
5757

5858
## Recipes
5959

60-
Recipes are named, multi-step scripts defined in your `config.yaml`. They allow
60+
Recipes are named, multi-step scripts defined in your `repos.yaml`. They allow
6161
you to codify and reuse common workflows.
6262

6363
### Defining a Recipe
6464

65-
Add a `recipes` section to your `config.yaml`:
65+
Add a `recipes` section to your `repos.yaml`:
6666

6767
```yaml
6868
recipes:

docs/plugins.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -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)
4343
6. 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:
174174
echo "=== Repository Health Check ==="
175175

176176
# Parse arguments
177-
CONFIG_FILE="config.yaml"
177+
CONFIG_FILE="repos.yaml"
178178
VERBOSE=false
179179

180180
while [[ $# -gt 0 ]]; do
@@ -222,7 +222,7 @@ import sys
222222

223223
def 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:
291291
repos 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
297297
repos 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
347347
import 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:
356356
use serde_yaml;
357357
use std::fs;
358358

359-
let content = fs::read_to_string("config.yaml")?;
359+
let content = fs::read_to_string("repos.yaml")?;
360360
let config: serde_yaml::Value = serde_yaml::from_str(&content)?;
361361
```
362362

0 commit comments

Comments
 (0)