Skip to content

Commit ee37081

Browse files
committed
Remove docs about sync back workflow
In favour of docs in the script itself
1 parent 5df1d6e commit ee37081

File tree

1 file changed

+1
-37
lines changed

1 file changed

+1
-37
lines changed

pr-checks/readme.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,6 @@ to one of the files in this directory.
99
1. Install https://github.com/casey/just by whichever way you prefer.
1010
2. Run `just update-pr-checks` in your terminal.
1111

12-
### If you don't want to intall `just`
12+
### If you don't want to install `just`
1313

1414
Manually run each step in the `justfile`.
15-
16-
## Sync-back automation
17-
18-
When Dependabot updates action versions in the generated workflow files (`.github/workflows/__*.yml`),
19-
the sync-back automation ensures those changes are properly reflected in the source templates.
20-
21-
The sync-back script automatically detects all actions used in generated workflows and preserves
22-
version comments (e.g., `# v1.2.3`) when syncing versions between files.
23-
24-
### Running sync-back manually
25-
26-
To sync action versions from generated workflows back to source templates:
27-
28-
```bash
29-
# Dry run to see what would be changed
30-
python3 pr-checks/sync_back.py --dry-run --verbose
31-
32-
# Actually apply the changes
33-
python3 pr-checks/sync_back.py
34-
```
35-
36-
The sync-back script automatically updates:
37-
- Hardcoded action versions in `pr-checks/sync.py`
38-
- Action version references in template files in `pr-checks/checks/`
39-
40-
Regular workflow files are updated directly by Dependabot and don't need sync-back.
41-
42-
This ensures that the `verify-pr-checks.sh` test always passes after Dependabot PRs.
43-
44-
### Testing
45-
46-
The sync-back script includes comprehensive tests that can be run with:
47-
48-
```bash
49-
python3 pr-checks/test_sync_back.py -v
50-
```

0 commit comments

Comments
 (0)