1
0
Fork 0

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>
This commit is contained in:
Kenny Cheng 2025-06-02 21:55:04 +08:00 committed by LUCI
parent 21269c3eed
commit 82d500eb7a
3 changed files with 58 additions and 0 deletions

View file

@ -133,3 +133,43 @@ def main(project_list, worktree_list=None, **kwargs):
kwargs: Leave this here for forward-compatibility. kwargs: Leave this here for forward-compatibility.
""" """
``` ```
### post-sync
This hook runs when `repo sync` completes without errors.
Note: This includes cases where no actual checkout may occur. The hook will still run.
For example:
- `repo sync -n` performs network fetches only and skips the checkout phase.
- `repo sync <project>` only updates the specified project(s).
- Partial failures may still result in a successful exit.
This hook is useful for post-processing tasks such as setting up git hooks,
bootstrapping configuration files, or running project initialization logic.
The hook is defined using the existing `<repo-hooks>` manifest block and is
optional. If the hook script fails or is missing, `repo sync` will still
complete successfully, and the error will be printed as a warning.
Example:
```xml
<project name="myorg/dev-tools" path="tools" revision="main" />
<repo-hooks in-project="myorg/dev-tools" enabled-list="post-sync">
<hook name="post-sync" />
</repo-hooks>
```
The `post-sync.py` file should be defined like:
```py
def main(repo_topdir=None, **kwargs):
"""Main function invoked directly by repo.
We must use the name "main" as that is what repo requires.
Args:
repo_topdir: The absolute path to the top-level directory of the repo workspace.
kwargs: Leave this here for forward-compatibility.
"""
```

View file

@ -25,6 +25,7 @@ from git_refs import HEAD
# The API we've documented to hook authors. Keep in sync with repo-hooks.md. # The API we've documented to hook authors. Keep in sync with repo-hooks.md.
_API_ARGS = { _API_ARGS = {
"pre-upload": {"project_list", "worktree_list"}, "pre-upload": {"project_list", "worktree_list"},
"post-sync": {"repo_topdir"},
} }

View file

@ -68,6 +68,7 @@ from git_config import GetUrlCookieFile
from git_refs import HEAD from git_refs import HEAD
from git_refs import R_HEADS from git_refs import R_HEADS
import git_superproject import git_superproject
from hooks import RepoHook
import platform_utils import platform_utils
from progress import elapsed_str from progress import elapsed_str
from progress import jobs_str from progress import jobs_str
@ -623,6 +624,7 @@ later is required to fix a server side protocol bug.
action="store_true", action="store_true",
help=optparse.SUPPRESS_HELP, help=optparse.SUPPRESS_HELP,
) )
RepoHook.AddOptionGroup(p, "post-sync")
def _GetBranch(self, manifest_project): def _GetBranch(self, manifest_project):
"""Returns the branch name for getting the approved smartsync manifest. """Returns the branch name for getting the approved smartsync manifest.
@ -1847,6 +1849,21 @@ later is required to fix a server side protocol bug.
except (KeyboardInterrupt, Exception) as e: except (KeyboardInterrupt, Exception) as e:
raise RepoUnhandledExceptionError(e, aggregate_errors=errors) raise RepoUnhandledExceptionError(e, aggregate_errors=errors)
# Run post-sync hook only after successful sync
self._RunPostSyncHook(opt)
def _RunPostSyncHook(self, opt):
"""Run post-sync hook if configured in manifest <repo-hooks>."""
hook = RepoHook.FromSubcmd(
hook_type="post-sync",
manifest=self.manifest,
opt=opt,
abort_if_user_denies=False,
)
success = hook.Run(repo_topdir=self.client.topdir)
if not success:
print("Warning: post-sync hook reported failure.")
def _ExecuteHelper(self, opt, args, errors): def _ExecuteHelper(self, opt, args, errors):
manifest = self.outer_manifest manifest = self.outer_manifest
if not opt.outer_manifest: if not opt.outer_manifest: