Google Git
Sign in
gerrit / git-repo.git / 82d500eb7aa93f9bff66a4358a08d2ba2d599550
commit82d500eb7aa93f9bff66a4358a08d2ba2d599550[log] [tgz]
authorKenny Cheng <chao.shun.cheng.tw@gmail.com>Mon Jun 02 21:55:04 2025 +0800
committerLUCI <gerrit-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jul 01 16:11:50 2025 -0700
tree60d2003fa946943a13bfb9a96bd88bb60167c57f
parent21269c3eedc428610a5cab1494b2459a7e939fc7 [diff]
sync: support post-sync hook in <repo-hooks>

Add support for a new hook type "post-sync" declared in the manifest using
<repo-hooks>. This allows executing a script automatically after a successful
`repo sync`.

This is useful for initializing developer environments, installing project-wide
Git hooks, generating configs, and other post-sync automation tasks.

Example manifest usage:

  <project name="myorg/repo-hooks" path="hooks" revision="main" />
  <repo-hooks in-project="myorg/repo-hooks" enabled-list="post-sync">
    <hook name="post-sync" />
  </repo-hooks>

The hook script must be named `post-sync.py` and located at the root of the
hook project.

The post-sync hook does not block `repo sync`; if the script fails, the sync
still completes successfully with a warning.

Test: Added `post-sync.py` in hook project and verified it runs after `repo sync`

Bug: b/421694721
Change-Id: I69f3158f0fc319d73a85028d6e90fea02c1dc8c8
Signed-off-by: Kenny Cheng <chao.shun.cheng.tw@gmail.com>
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/480581
Reviewed-by: Scott Lee <ddoman@google.com>
Reviewed-by: Gavin Mak <gavinmak@google.com>
3 files changed
tree: 60d2003fa946943a13bfb9a96bd88bb60167c57f
  1. .github/
  2. docs/
  3. hooks/
  4. man/
  5. release/
  6. subcmds/
  7. tests/
  8. .flake8
  9. .gitattributes
  10. .gitignore
  11. .gitreview
  12. .isort.cfg
  13. .mailmap
  14. .project
  15. .pydevproject
  16. color.py
  17. command.py
  18. completion.bash
  19. constraints.txt
  20. editor.py
  21. error.py
  22. event_log.py
  23. fetch.py
  24. git_command.py
  25. git_config.py
  26. git_refs.py
  27. git_ssh
  28. git_superproject.py
  29. git_trace2_event_log.py
  30. git_trace2_event_log_base.py
  31. hooks.py
  32. LICENSE
  33. main.py
  34. MANIFEST.in
  35. manifest_xml.py
  36. pager.py
  37. platform_utils.py
  38. platform_utils_win32.py
  39. progress.py
  40. project.py
  41. pyproject.toml
  42. README.md
  43. repo
  44. repo_logging.py
  45. repo_trace.py
  46. requirements.json
  47. run_tests
  48. run_tests.vpython3
  49. run_tests.vpython3.8
  50. setup.py
  51. ssh.py
  52. SUBMITTING_PATCHES.md
  53. tox.ini
  54. wrapper.py
README.md

repo

Repo is a tool built on top of Git. Repo helps manage many Git repositories, does the uploads to revision control systems, and automates parts of the development workflow. Repo is not meant to replace Git, only to make it easier to work with Git. The repo command is an executable Python script that you can put anywhere in your path.

Contact

Please use the repo-discuss mailing list or issue tracker for questions.

You can file a new bug report under the “repo” component.

Please do not e-mail individual developers for support. They do not have the bandwidth for it, and often times questions have already been asked on repo-discuss or bugs posted to the issue tracker. So please search those sites first.

Install

Many distros include repo, so you might be able to install from there.

# Debian/Ubuntu.
$ sudo apt-get install repo

# Gentoo.
$ sudo emerge dev-vcs/repo

You can install it manually as well as it's a single script.

$ mkdir -p ~/.bin
$ PATH="${HOME}/.bin:${PATH}"
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
$ chmod a+rx ~/.bin/repo