Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 2.13 KB

README.md

File metadata and controls

36 lines (26 loc) · 2.13 KB

GitScale documentation

GitScale manages several git repositories as one workspace, from a single .gitscale.toml file.

Contents

1. Overview — what GitScale is, and getting a workspace.

2. Guides

2.1 Declaring dependencies — adding and removing entries, artefacts, and pinning to a branch, tag or SHA
2.2 The workspace — reading git scale ls, every flag it prints, topics, and its JSON output; git explain, why a checkout has its revision
2.3 Recursive dependencies — how every repository's requests resolve to one revision per major, overrides, implicit dependencies, and symlink dedup
2.4 Everyday workflow — git commands across the workspace with git scale <git command>, a plain clone and a bare clone with worktrees, and CI on hosted runners
2.5 Stores, placement and the CI cache — where checkouts come from, placement, roots made of worktrees, moving and deleting, image pruning, and the cache commands
2.6 Topics — one change across several repositories: git topic, git upgrade, git scale check, and topics in CI
2.7 Hooks — [hooks] config commands, and installing GitScale as a git hook
2.8 CI authentication — using the runner's own job token, with no pipeline setup
2.9 Cleaning — git scale clean, what it always keeps, and git scale gc
2.10 Artefacts — publishing build output to an OCI registry, and installing a release's instead of a checkout
2.11 The agent skill — teaching coding agents the GitScale workflow: git scale skill, how it stays current

3. Configuration file reference — every table, key and environment variable.

4. Command line reference — every command, argument and flag.

5. Related tools — how GitScale compares to submodules, Google repo, west, vcstool and others.


Contents · Next → 1. Overview