Repositories

​

Why repositories live in gaal.yaml

• Reproducibility, the same gaal sync produces the same checked-out tree on every machine.
• Pinning, every entry can pin to a tag, branch, or commit.
• Multi-protocol, Git is the common case, but tar and zip work for releases that aren’t on a forge.

​

Supported types

​

Shape

repositories:
  <local-path>:
    type: git | hg | svn | bzr | tar | zip
    url:  <remote-url-or-local-path>
    version: <branch | tag | commit | revision | prefix>   # optional

​

Examples

repositories:
  src/gaal:                       # git, branch
    type: git
    url: https://github.com/getgaal/gaal.git
    version: main

  src/tools/my-python-lib:        # git, tag pin
    type: git
    url: https://github.com/example/my-python-lib.git
    version: v2.1.0

  src/legacy/old-tool:            # svn revision
    type: svn
    url: https://svn.example.com/repos/old-tool/trunk
    version: "1234"

  src/data/dataset:               # release tarball
    type: tar
    url: https://example.com/releases/dataset-2024.tar.gz
    version: dataset-2024         # strip this prefix on extract

​

Behaviour during sync

• First sync, the repo is cloned (or extracted) into the configured path.
• Subsequent syncs, git fetch + checkout for VCS types; re-download + re-extract for archive types when the URL or version changes.
• --dry-run prints + clone, ~ update, or = unchanged for every entry.
• --prune does not delete repository directories. Removing a repo from gaal.yaml simply leaves it on disk; remove it manually if you don’t want it.

​

Authentication

• HTTPS Git, credentials come from your ~/.netrc or your Git credential helper.
• SSH Git, your SSH agent and ~/.ssh/config are used as-is.
• Hg/SVN/Bzr, same as if you ran hg clone, svn checkout, or bzr branch yourself.
• tar/zip, gaal sends a plain GET. Use a pre-signed URL or a ~/.netrc entry for the host.

​

Related