Skip to content

Commit 00953ca

Browse files
authored
Update README.md
file renaming adjustment
1 parent 8e331c8 commit 00953ca

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Keeps your full commit history and contribution graphs in sync across both platf
4646
│ └── workflows/
4747
│ ├── mirror-to-gitlab.yml # Mirror setup workflow
4848
│ └── prune-stale.yml # Prune stale projects workflow
49-
├── mirror_repos.py # Python script for mirror setup
50-
├── prune_repos.py # Python script for pruning stale projects
49+
├── sync_repos.py # Python script for mirror setup
50+
├── cleanup_pruned_repos.py # Python script for pruning stale projects
5151
└── README.md # This documentation
5252
```
5353

@@ -76,12 +76,12 @@ Hard-coded in the workflows:
7676
### 1. Mirroring
7777

7878
- The **mirror-to-gitlab.yml** workflow runs on schedule (daily at 03:00 UTC by default) or manual dispatch.
79-
- It installs dependencies, runs `mirror_repos.py`, and ensures each GitHub repo exists in GitLab with pull-mirror + fallback push-mirror.
79+
- It installs dependencies, runs `sync_repos.py`, and ensures each GitHub repo exists in GitLab with pull-mirror + fallback push-mirror.
8080

8181
### 2. Pruning Stale Projects
8282

8383
- The **prune-stale.yml** workflow runs weekly (Sunday at 03:00 UTC by default) or manual dispatch.
84-
- It restores `prune_state.json`, runs `prune_repos.py` in **dry-run** mode by default, and updates the cache.
84+
- It restores `prune_state.json`, runs `cleanup_pruned_repos.py` in **dry-run** mode by default, and updates the cache.
8585

8686
#### Checking Dry-Run Output
8787

@@ -109,7 +109,7 @@ Hard-coded in the workflows:
109109

110110
## How It Works
111111

112-
### mirror_repos.py
112+
### sync_repos.py
113113

114114
1. **fetch_repos()**
115115
- Lists private & owned repos via `GET /user/repos`
@@ -124,7 +124,7 @@ Hard-coded in the workflows:
124124
- Configures a **pull mirror** in GitLab
125125
- Falls back to `git clone --mirror` + `git push --mirror` for edge cases
126126

127-
### prune_repos.py
127+
### cleanup_pruned_repos.py
128128

129129
1. **fetch_github_repos()**
130130
- Same dual-fetch logic as mirror script
@@ -151,7 +151,7 @@ Hard-coded in the workflows:
151151
- **Cron schedules:** Adjust `cron` entries in workflows.
152152
- **Grace period:** Change `GRACE_DAYS` in prune workflow env.
153153
- **Exclusions:** Update `PRUNE_EXCLUDE` to protect essential projects.
154-
- **Visibility:** Modify payload in `mirror_repos.py` to create public mirrors.
154+
- **Visibility:** Modify payload in `sync_repos.py` to create public mirrors.
155155
- **Rate limiting:** Tweak `time.sleep(1)` in mirror script as needed.
156156

157157
***

0 commit comments

Comments
 (0)