repo-fix/README.md

55 lines
1.6 KiB
Markdown

# repo-fix
![version](https://assets.dandaedre.com/coverage/Chado/repo-fix/main/version.svg)
![tests](https://assets.dandaedre.com/coverage/Chado/repo-fix/main/test.svg)
![test coverage](https://assets.dandaedre.com/coverage/Chado/repo-fix/main/coverage.svg)
Normalize Dandaedre Gitea submodule URLs after cloning, pulling, or syncing:
- `.gitmodules` uses HTTPS through `proxy.dandaedre.com` for CI.
- Local Git configuration uses SSH through `git.dandaedre.com`.
- Initialized and nested submodule remotes are updated as well.
The script requires Python 3.10 or newer and Git. It has no runtime Python
dependencies and does not fetch repositories or submodules.
## Usage
Preview changes first, then apply them:
```bash
python3 fix_submodules.py /path/to/repository --dry-run
python3 fix_submodules.py /path/to/repository
```
The repository path defaults to the current directory and may point anywhere
inside a working tree. Repeated runs are safe.
After applying the changes, commit `.gitmodules` when it changed. Local Git
configuration is intentionally not committed. You can then initialize the
submodules:
```bash
git -C /path/to/repository submodule update --init --recursive
```
Show the current semantic version with:
```bash
python3 fix_submodules.py --version
```
## Development
Run the dependency-free unit suite with:
```bash
python3 -m unittest discover -s tests -v
```
## Advanced
- [URL handling and Git layout support](docs/advanced.md#url-handling-and-git-layouts)
- [Testing, fuzz cases, and coverage](docs/advanced.md#testing-and-coverage)
- [Jenkins CI and dependency gates](docs/advanced.md#jenkins-ci)