super-agents 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- super_agents-0.1.0/.gitignore +13 -0
- super_agents-0.1.0/.reports/super-agent-instructions-read-diagnostic.md +107 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/FETCH_HEAD +4 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/HEAD +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/config +12 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/description +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/applypatch-msg.sample +15 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/commit-msg.sample +24 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/fsmonitor-watchman.sample +174 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/post-update.sample +8 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/pre-applypatch.sample +14 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/pre-commit.sample +49 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/pre-merge-commit.sample +13 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/pre-push.sample +53 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/pre-rebase.sample +169 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/pre-receive.sample +24 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/prepare-commit-msg.sample +42 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/push-to-checkout.sample +78 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/sendemail-validate.sample +77 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/hooks/update.sample +128 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/info/exclude +6 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/logs/HEAD +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/logs/refs/heads/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/logs/refs/remotes/source/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/0d/c592d94a8be955e750ecd40bf57912587dd5f2 +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/18/cbc8fdbdd653083d740f8b51224c7f159ca1f3 +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/2f/e1268b0715c7f672156f1b033fbb71a4c6048c +3 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/33/4673173452d57db29faa882e8f4d3c8eda1cec +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/4c/425465e94ef12ace4cfd15eacd85216d5bd798 +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/54/5ace93520aa7226d9ff5c291a02323589cf4fa +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/5a/88a07af4bae3811727759ab320a8f757d2ffc8 +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/5b/33eeb7a4d6f927e7947fd4871856c19831ea15 +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/5b/cb76c4a1784904ae86ec2ba6f8404f90671c85 +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/90/8c235338d279b258218150e677afed271d300e +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/99/14529403965f7fd76efab340c48b526f31705d +2 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/9c/daa18f911092e24ed635ba765c4f012f55d06e +2 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/9f/a9ec995b7dda2c3a8bd598c9a79723f4113454 +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/ea/656351d0f1c9b7c2a185efa5b6b275d11f5952 +2 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/ef/96455ab38ffc5d62a26788eeebb989a5ad78bc +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/pack/pack-4a027fec4d62160be0643f9e0e815f44ea191a1b.idx +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/pack/pack-4a027fec4d62160be0643f9e0e815f44ea191a1b.pack +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/objects/pack/pack-4a027fec4d62160be0643f9e0e815f44ea191a1b.rev +0 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/heads/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/original/refs/heads/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/original/refs/remotes/source/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/remotes/origin/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/remotes/source/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/source/heads/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/source/remotes/origin/HEAD +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/source/remotes/origin/main +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/refs/tags/v0.1.0 +1 -0
- super_agents-0.1.0/.weekend-commit-rewriter.git/weekend-commit-map.json +17 -0
- super_agents-0.1.0/LICENSE +18 -0
- super_agents-0.1.0/PKG-INFO +232 -0
- super_agents-0.1.0/README.md +215 -0
- super_agents-0.1.0/pyproject.toml +49 -0
- super_agents-0.1.0/src/super_agents/__init__.py +27 -0
- super_agents-0.1.0/src/super_agents/__main__.py +4 -0
- super_agents-0.1.0/src/super_agents/app_client_routines.py +199 -0
- super_agents-0.1.0/src/super_agents/app_client_sessions.py +442 -0
- super_agents-0.1.0/src/super_agents/app_client_transport.py +349 -0
- super_agents-0.1.0/src/super_agents/app_environment.py +79 -0
- super_agents-0.1.0/src/super_agents/app_formatting.py +142 -0
- super_agents-0.1.0/src/super_agents/app_models.py +116 -0
- super_agents-0.1.0/src/super_agents/app_permissions.py +107 -0
- super_agents-0.1.0/src/super_agents/app_protocol.py +219 -0
- super_agents-0.1.0/src/super_agents/app_queue.py +198 -0
- super_agents-0.1.0/src/super_agents/app_routines.py +121 -0
- super_agents-0.1.0/src/super_agents/app_server_client.py +890 -0
- super_agents-0.1.0/src/super_agents/app_sessions.py +97 -0
- super_agents-0.1.0/src/super_agents/app_time.py +67 -0
- super_agents-0.1.0/src/super_agents/mcp_server.py +623 -0
- super_agents-0.1.0/src/super_agents/state.py +352 -0
- super_agents-0.1.0/tests/test_app_server_client.py +1467 -0
- super_agents-0.1.0/tests/test_mcp_server.py +35 -0
- super_agents-0.1.0/uv.lock +852 -0
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Super Agent Instructions Read Diagnostic
|
|
2
|
+
|
|
3
|
+
Date: 2026-05-22
|
|
4
|
+
|
|
5
|
+
## Summary
|
|
6
|
+
|
|
7
|
+
New Super Agents were not consistently reading `/Users/gabemontague/.openbase/codex_home/super-agent-instructions.md` because this MCP server did not read that file. The Python MCP implementation only forwarded `developerInstructions` when the MCP caller explicitly supplied that field.
|
|
8
|
+
|
|
9
|
+
The likely cause of the observed split result is that one launch path injected the contents of `super-agent-instructions.md` as explicit developer instructions, while another path used the direct `super_agents_start` / `super_agents_start_turn` tools without doing so. Direct MCP tool calls currently inherit the normal Codex home/project instruction discovery, such as `/Users/gabemontague/.openbase/codex_home/AGENTS.md`, but not `super-agent-instructions.md`.
|
|
10
|
+
|
|
11
|
+
Fix implemented: `src/super_agents/mcp_server.py` now loads default Super Agent developer instructions at MCP input-cleaning time and applies them to new threads, direct follow-up turns, and queued turns when callers omit `developerInstructions`.
|
|
12
|
+
|
|
13
|
+
## Evidence
|
|
14
|
+
|
|
15
|
+
- Before the fix, `src/super_agents/mcp_server.py` defined `super_agents_start`, `super_agents_start_turn`, and `super_agents_queue_turn` with an optional `developerInstructions` input field, but no default instruction-file loading.
|
|
16
|
+
- `src/super_agents/app_server_client.py` sends `developerInstructions` to `thread/start` only if `input_data.get("developerInstructions")` is truthy.
|
|
17
|
+
- `src/super_agents/app_server_client.py` always builds `turn/start` with `collaborationMode.settings.developer_instructions`, but the value is only taken from the tool input. If omitted, it is `None`.
|
|
18
|
+
- `resume_thread()` calls `thread/resume` with `threadId`, `approvalPolicy`, `sandbox`, and shell config only. It does not read or reapply any Super Agent instruction file.
|
|
19
|
+
- `queue_turn_by_label()` stores the cleaned turn input and `_drain_queue()` later calls `start_turn()` with that stored input. If the queued call omitted `developerInstructions`, queued execution also omits the Super Agent instructions.
|
|
20
|
+
- Repository search found no references to `super-agent-instructions.md` or `CODEX_SUPER_AGENT_INSTRUCTIONS_PATH` in `src/`, `tests/`, `legacy/`, or `README.md`.
|
|
21
|
+
- `default_reasoning_effort()` reads `SUPER_AGENTS_DEFAULT_CONFIG_PATH`, `LIVEKIT_DISPATCHER_CONFIG_PATH`, or `~/.openbase/codex_home/dispatcher-config.json`, but only for reasoning effort. It does not load instructions.
|
|
22
|
+
- `login_shell_config_override()` passes shell environment policy to Codex app-server. It sets environment variables such as `PATH`, `SHELL`, `HOME`, `USER`, and `LOGNAME`; it does not set instruction content or instruction paths.
|
|
23
|
+
|
|
24
|
+
Current local files also show why the random-animal test is a useful detector:
|
|
25
|
+
|
|
26
|
+
- `/Users/gabemontague/.openbase/codex_home/super-agent-instructions.md` contains `The random animal is "raccoon".`
|
|
27
|
+
- `/Users/gabemontague/.openbase/codex_home/AGENTS.md` contains `The random animal is "monkey".`
|
|
28
|
+
|
|
29
|
+
A Super Agent answering `raccoon` saw the Super Agent instruction file through some path outside this MCP's default direct tool behavior. A Super Agent answering `unknown` probably did not receive either the Super Agent file or a clear relevant instruction in its active context. A direct `super_agents_start` thread should not be expected to know `raccoon` unless the caller passed that file content as `developerInstructions`.
|
|
30
|
+
|
|
31
|
+
## Flow Coverage
|
|
32
|
+
|
|
33
|
+
`super_agents_start`
|
|
34
|
+
|
|
35
|
+
- Tool path: `mcp_server.py` -> `clean_thread_input()` -> `CodexAppServerClient.start_thread()`.
|
|
36
|
+
- Sends `thread/start` with `cwd`, `approvalPolicy`, `sandbox`, and shell config.
|
|
37
|
+
- Adds `developerInstructions` only when provided by the caller.
|
|
38
|
+
- Does not read `CODEX_SUPER_AGENT_INSTRUCTIONS_PATH`.
|
|
39
|
+
- Does not read `~/.openbase/codex_home/super-agent-instructions.md`.
|
|
40
|
+
- Does not read dispatcher config for instructions.
|
|
41
|
+
|
|
42
|
+
`super_agents_start_turn`
|
|
43
|
+
|
|
44
|
+
- Tool path: `mcp_server.py` -> `clean_start_turn_by_name_input()` -> `CodexAppServerClient.start_turn_by_label()` -> `start_turn()`.
|
|
45
|
+
- Resolves an existing named thread and sends `turn/start`.
|
|
46
|
+
- Includes `collaborationMode.settings.developer_instructions` as the caller-provided value or `None`.
|
|
47
|
+
- Does not load default Super Agent instructions for follow-up turns.
|
|
48
|
+
|
|
49
|
+
`super_agents_queue_turn`
|
|
50
|
+
|
|
51
|
+
- Tool path: `mcp_server.py` -> `clean_queue_turn_input()` -> `queue_turn_by_label()` -> `_drain_queue()` -> `start_turn()`.
|
|
52
|
+
- Queued turns preserve only the provided turn input.
|
|
53
|
+
- If `developerInstructions` was absent at queue time, the eventual turn starts with `developer_instructions: None`.
|
|
54
|
+
|
|
55
|
+
`super_agents_resume`
|
|
56
|
+
|
|
57
|
+
- Tool path: `resume_by_label()` -> `resume_thread()`.
|
|
58
|
+
- Resumes an existing app-server thread.
|
|
59
|
+
- Does not pass new developer instructions.
|
|
60
|
+
- Existing named threads created before an instruction-file change can retain whatever instruction context was stored when the thread was created or previously run. The MCP state file does not persist developer instructions, so the MCP cannot update old named threads automatically from `super-agent-instructions.md`.
|
|
61
|
+
|
|
62
|
+
## Named Thread Reuse
|
|
63
|
+
|
|
64
|
+
`super_agents_start_turn` resolves the latest matching named thread, defaulting to `latest_any` inside `start_turn_by_label()`. That means a "fresh" test can accidentally reuse an existing named thread if the name is reused. In that case, the result may reflect old thread context rather than the current instruction file.
|
|
65
|
+
|
|
66
|
+
Even for truly new names, direct `super_agents_start` only passes default Codex app-server thread configuration. The app-server may load normal Codex home/project instructions, but this repo does not tell it to load `super-agent-instructions.md`.
|
|
67
|
+
|
|
68
|
+
## Recommended Fix
|
|
69
|
+
|
|
70
|
+
Add a single default-instruction loader in this MCP server and apply it consistently before app-server requests are built. This fix has now been implemented.
|
|
71
|
+
|
|
72
|
+
Recommended behavior:
|
|
73
|
+
|
|
74
|
+
1. Resolve the instruction path from `CODEX_SUPER_AGENT_INSTRUCTIONS_PATH` if set.
|
|
75
|
+
2. Otherwise use `$CODEX_HOME/super-agent-instructions.md` if `CODEX_HOME` is set.
|
|
76
|
+
3. Otherwise use `~/.openbase/codex_home/super-agent-instructions.md`.
|
|
77
|
+
4. Read the file at call time, not process startup time, so changes are picked up by new threads and new turns without restarting the MCP process.
|
|
78
|
+
5. For `super_agents_start`, use the caller-provided `developerInstructions` if supplied; otherwise use the loaded default.
|
|
79
|
+
6. For `super_agents_start_turn` and `super_agents_queue_turn`, also default missing `developerInstructions` to the loaded file. Preserve explicit `developerInstructions: null` as an escape hatch if callers need to suppress the default.
|
|
80
|
+
7. For `super_agents_resume`, either keep resume as a pure resume operation and document that it does not update existing thread instructions, or add an explicit follow-up-turn path that reapplies defaults. Do not assume resume alone can mutate prior thread context.
|
|
81
|
+
|
|
82
|
+
The implementation is in `mcp_server.py` input cleaning, before `CodexAppServerClient` receives the sanitized payload. That keeps instruction policy at the MCP boundary and avoids changing the lower-level app-server client semantics.
|
|
83
|
+
|
|
84
|
+
## Fix Applied
|
|
85
|
+
|
|
86
|
+
- Added `default_super_agent_instructions_path()` with this precedence:
|
|
87
|
+
1. `CODEX_SUPER_AGENT_INSTRUCTIONS_PATH`
|
|
88
|
+
2. `$CODEX_HOME/super-agent-instructions.md`
|
|
89
|
+
3. `~/.openbase/codex_home/super-agent-instructions.md`
|
|
90
|
+
- Added `default_super_agent_instructions()` to read the file at call time, so new threads and turns can pick up file edits without a Python process restart.
|
|
91
|
+
- Updated `clean_thread_input()` so `super_agents_start` defaults missing `developerInstructions` to the loaded file.
|
|
92
|
+
- Updated `clean_turn_input()` so `super_agents_start_turn` and `super_agents_queue_turn` default missing `developerInstructions` to the loaded file.
|
|
93
|
+
- Preserved explicit caller-provided developer instructions as the highest-priority value.
|
|
94
|
+
- Preserved explicit `developerInstructions: null` as a turn-flow escape hatch to suppress the default.
|
|
95
|
+
|
|
96
|
+
## Verification Performed
|
|
97
|
+
|
|
98
|
+
- Searched the repo for `super-agent-instructions`, `CODEX_SUPER_AGENT_INSTRUCTIONS_PATH`, `developerInstructions`, `developer_instructions`, dispatcher config usage, and Super Agents tool entry points.
|
|
99
|
+
- Read the Python MCP tool definitions and app-server client request builders.
|
|
100
|
+
- Compared the current Codex home `super-agent-instructions.md`, `AGENTS.md`, and dispatcher config.
|
|
101
|
+
- Added focused tests for configured instruction path loading, `$CODEX_HOME` fallback loading, explicit override behavior, and explicit-null suppression for turn flows.
|
|
102
|
+
- Ran focused Python tests with cache disabled: `PYTHONDONTWRITEBYTECODE=1 pytest -q -p no:cacheprovider tests/test_app_server_client.py tests/test_mcp_server.py`.
|
|
103
|
+
- Result: `27 passed`.
|
|
104
|
+
|
|
105
|
+
## Reload Note
|
|
106
|
+
|
|
107
|
+
The MCP process that exposes these tools must be reloaded before already-running clients see the code change. No service restart was performed as part of this task.
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
c8e296a6c0e7c3ac5f3a1170c1dc4b09cdaa4363 branch 'main' of /Users/gabemontague/Projects/super-agents
|
|
2
|
+
c8e296a6c0e7c3ac5f3a1170c1dc4b09cdaa4363 remote-tracking branch 'origin/HEAD' of /Users/gabemontague/Projects/super-agents
|
|
3
|
+
c8e296a6c0e7c3ac5f3a1170c1dc4b09cdaa4363 remote-tracking branch 'origin/main' of /Users/gabemontague/Projects/super-agents
|
|
4
|
+
2edeb4de0949988a4b1bd50156a1fbfb733aad14 not-for-merge tag 'v0.1.0' of /Users/gabemontague/Projects/super-agents
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
ref: refs/heads/main
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
[core]
|
|
2
|
+
repositoryformatversion = 0
|
|
3
|
+
filemode = true
|
|
4
|
+
bare = true
|
|
5
|
+
ignorecase = true
|
|
6
|
+
precomposeunicode = true
|
|
7
|
+
[remote "source"]
|
|
8
|
+
url = /Users/gabemontague/Projects/super-agents
|
|
9
|
+
fetch = +refs/heads/*:refs/remotes/source/*
|
|
10
|
+
[remote "origin"]
|
|
11
|
+
url = git@github.com:montaguegabe/super-agents.git
|
|
12
|
+
fetch = +refs/heads/*:refs/remotes/origin/*
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Unnamed repository; edit this file 'description' to name the repository.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# An example hook script to check the commit log message taken by
|
|
4
|
+
# applypatch from an e-mail message.
|
|
5
|
+
#
|
|
6
|
+
# The hook should exit with non-zero status after issuing an
|
|
7
|
+
# appropriate message if it wants to stop the commit. The hook is
|
|
8
|
+
# allowed to edit the commit message file.
|
|
9
|
+
#
|
|
10
|
+
# To enable this hook, rename this file to "applypatch-msg".
|
|
11
|
+
|
|
12
|
+
. git-sh-setup
|
|
13
|
+
commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
|
|
14
|
+
test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
|
|
15
|
+
:
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# An example hook script to check the commit log message.
|
|
4
|
+
# Called by "git commit" with one argument, the name of the file
|
|
5
|
+
# that has the commit message. The hook should exit with non-zero
|
|
6
|
+
# status after issuing an appropriate message if it wants to stop the
|
|
7
|
+
# commit. The hook is allowed to edit the commit message file.
|
|
8
|
+
#
|
|
9
|
+
# To enable this hook, rename this file to "commit-msg".
|
|
10
|
+
|
|
11
|
+
# Uncomment the below to add a Signed-off-by line to the message.
|
|
12
|
+
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
|
|
13
|
+
# hook is more suited to it.
|
|
14
|
+
#
|
|
15
|
+
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
|
16
|
+
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
|
|
17
|
+
|
|
18
|
+
# This example catches duplicate Signed-off-by lines.
|
|
19
|
+
|
|
20
|
+
test "" = "$(grep '^Signed-off-by: ' "$1" |
|
|
21
|
+
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
|
|
22
|
+
echo >&2 Duplicate Signed-off-by lines.
|
|
23
|
+
exit 1
|
|
24
|
+
}
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
#!/usr/bin/perl
|
|
2
|
+
|
|
3
|
+
use strict;
|
|
4
|
+
use warnings;
|
|
5
|
+
use IPC::Open2;
|
|
6
|
+
|
|
7
|
+
# An example hook script to integrate Watchman
|
|
8
|
+
# (https://facebook.github.io/watchman/) with git to speed up detecting
|
|
9
|
+
# new and modified files.
|
|
10
|
+
#
|
|
11
|
+
# The hook is passed a version (currently 2) and last update token
|
|
12
|
+
# formatted as a string and outputs to stdout a new update token and
|
|
13
|
+
# all files that have been modified since the update token. Paths must
|
|
14
|
+
# be relative to the root of the working tree and separated by a single NUL.
|
|
15
|
+
#
|
|
16
|
+
# To enable this hook, rename this file to "query-watchman" and set
|
|
17
|
+
# 'git config core.fsmonitor .git/hooks/query-watchman'
|
|
18
|
+
#
|
|
19
|
+
my ($version, $last_update_token) = @ARGV;
|
|
20
|
+
|
|
21
|
+
# Uncomment for debugging
|
|
22
|
+
# print STDERR "$0 $version $last_update_token\n";
|
|
23
|
+
|
|
24
|
+
# Check the hook interface version
|
|
25
|
+
if ($version ne 2) {
|
|
26
|
+
die "Unsupported query-fsmonitor hook version '$version'.\n" .
|
|
27
|
+
"Falling back to scanning...\n";
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
my $git_work_tree = get_working_dir();
|
|
31
|
+
|
|
32
|
+
my $retry = 1;
|
|
33
|
+
|
|
34
|
+
my $json_pkg;
|
|
35
|
+
eval {
|
|
36
|
+
require JSON::XS;
|
|
37
|
+
$json_pkg = "JSON::XS";
|
|
38
|
+
1;
|
|
39
|
+
} or do {
|
|
40
|
+
require JSON::PP;
|
|
41
|
+
$json_pkg = "JSON::PP";
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
launch_watchman();
|
|
45
|
+
|
|
46
|
+
sub launch_watchman {
|
|
47
|
+
my $o = watchman_query();
|
|
48
|
+
if (is_work_tree_watched($o)) {
|
|
49
|
+
output_result($o->{clock}, @{$o->{files}});
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
sub output_result {
|
|
54
|
+
my ($clockid, @files) = @_;
|
|
55
|
+
|
|
56
|
+
# Uncomment for debugging watchman output
|
|
57
|
+
# open (my $fh, ">", ".git/watchman-output.out");
|
|
58
|
+
# binmode $fh, ":utf8";
|
|
59
|
+
# print $fh "$clockid\n@files\n";
|
|
60
|
+
# close $fh;
|
|
61
|
+
|
|
62
|
+
binmode STDOUT, ":utf8";
|
|
63
|
+
print $clockid;
|
|
64
|
+
print "\0";
|
|
65
|
+
local $, = "\0";
|
|
66
|
+
print @files;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
sub watchman_clock {
|
|
70
|
+
my $response = qx/watchman clock "$git_work_tree"/;
|
|
71
|
+
die "Failed to get clock id on '$git_work_tree'.\n" .
|
|
72
|
+
"Falling back to scanning...\n" if $? != 0;
|
|
73
|
+
|
|
74
|
+
return $json_pkg->new->utf8->decode($response);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
sub watchman_query {
|
|
78
|
+
my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
|
|
79
|
+
or die "open2() failed: $!\n" .
|
|
80
|
+
"Falling back to scanning...\n";
|
|
81
|
+
|
|
82
|
+
# In the query expression below we're asking for names of files that
|
|
83
|
+
# changed since $last_update_token but not from the .git folder.
|
|
84
|
+
#
|
|
85
|
+
# To accomplish this, we're using the "since" generator to use the
|
|
86
|
+
# recency index to select candidate nodes and "fields" to limit the
|
|
87
|
+
# output to file names only. Then we're using the "expression" term to
|
|
88
|
+
# further constrain the results.
|
|
89
|
+
my $last_update_line = "";
|
|
90
|
+
if (substr($last_update_token, 0, 1) eq "c") {
|
|
91
|
+
$last_update_token = "\"$last_update_token\"";
|
|
92
|
+
$last_update_line = qq[\n"since": $last_update_token,];
|
|
93
|
+
}
|
|
94
|
+
my $query = <<" END";
|
|
95
|
+
["query", "$git_work_tree", {$last_update_line
|
|
96
|
+
"fields": ["name"],
|
|
97
|
+
"expression": ["not", ["dirname", ".git"]]
|
|
98
|
+
}]
|
|
99
|
+
END
|
|
100
|
+
|
|
101
|
+
# Uncomment for debugging the watchman query
|
|
102
|
+
# open (my $fh, ">", ".git/watchman-query.json");
|
|
103
|
+
# print $fh $query;
|
|
104
|
+
# close $fh;
|
|
105
|
+
|
|
106
|
+
print CHLD_IN $query;
|
|
107
|
+
close CHLD_IN;
|
|
108
|
+
my $response = do {local $/; <CHLD_OUT>};
|
|
109
|
+
|
|
110
|
+
# Uncomment for debugging the watch response
|
|
111
|
+
# open ($fh, ">", ".git/watchman-response.json");
|
|
112
|
+
# print $fh $response;
|
|
113
|
+
# close $fh;
|
|
114
|
+
|
|
115
|
+
die "Watchman: command returned no output.\n" .
|
|
116
|
+
"Falling back to scanning...\n" if $response eq "";
|
|
117
|
+
die "Watchman: command returned invalid output: $response\n" .
|
|
118
|
+
"Falling back to scanning...\n" unless $response =~ /^\{/;
|
|
119
|
+
|
|
120
|
+
return $json_pkg->new->utf8->decode($response);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
sub is_work_tree_watched {
|
|
124
|
+
my ($output) = @_;
|
|
125
|
+
my $error = $output->{error};
|
|
126
|
+
if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) {
|
|
127
|
+
$retry--;
|
|
128
|
+
my $response = qx/watchman watch "$git_work_tree"/;
|
|
129
|
+
die "Failed to make watchman watch '$git_work_tree'.\n" .
|
|
130
|
+
"Falling back to scanning...\n" if $? != 0;
|
|
131
|
+
$output = $json_pkg->new->utf8->decode($response);
|
|
132
|
+
$error = $output->{error};
|
|
133
|
+
die "Watchman: $error.\n" .
|
|
134
|
+
"Falling back to scanning...\n" if $error;
|
|
135
|
+
|
|
136
|
+
# Uncomment for debugging watchman output
|
|
137
|
+
# open (my $fh, ">", ".git/watchman-output.out");
|
|
138
|
+
# close $fh;
|
|
139
|
+
|
|
140
|
+
# Watchman will always return all files on the first query so
|
|
141
|
+
# return the fast "everything is dirty" flag to git and do the
|
|
142
|
+
# Watchman query just to get it over with now so we won't pay
|
|
143
|
+
# the cost in git to look up each individual file.
|
|
144
|
+
my $o = watchman_clock();
|
|
145
|
+
$error = $output->{error};
|
|
146
|
+
|
|
147
|
+
die "Watchman: $error.\n" .
|
|
148
|
+
"Falling back to scanning...\n" if $error;
|
|
149
|
+
|
|
150
|
+
output_result($o->{clock}, ("/"));
|
|
151
|
+
$last_update_token = $o->{clock};
|
|
152
|
+
|
|
153
|
+
eval { launch_watchman() };
|
|
154
|
+
return 0;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
die "Watchman: $error.\n" .
|
|
158
|
+
"Falling back to scanning...\n" if $error;
|
|
159
|
+
|
|
160
|
+
return 1;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
sub get_working_dir {
|
|
164
|
+
my $working_dir;
|
|
165
|
+
if ($^O =~ 'msys' || $^O =~ 'cygwin') {
|
|
166
|
+
$working_dir = Win32::GetCwd();
|
|
167
|
+
$working_dir =~ tr/\\/\//;
|
|
168
|
+
} else {
|
|
169
|
+
require Cwd;
|
|
170
|
+
$working_dir = Cwd::cwd();
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
return $working_dir;
|
|
174
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# An example hook script to verify what is about to be committed
|
|
4
|
+
# by applypatch from an e-mail message.
|
|
5
|
+
#
|
|
6
|
+
# The hook should exit with non-zero status after issuing an
|
|
7
|
+
# appropriate message if it wants to stop the commit.
|
|
8
|
+
#
|
|
9
|
+
# To enable this hook, rename this file to "pre-applypatch".
|
|
10
|
+
|
|
11
|
+
. git-sh-setup
|
|
12
|
+
precommit="$(git rev-parse --git-path hooks/pre-commit)"
|
|
13
|
+
test -x "$precommit" && exec "$precommit" ${1+"$@"}
|
|
14
|
+
:
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# An example hook script to verify what is about to be committed.
|
|
4
|
+
# Called by "git commit" with no arguments. The hook should
|
|
5
|
+
# exit with non-zero status after issuing an appropriate message if
|
|
6
|
+
# it wants to stop the commit.
|
|
7
|
+
#
|
|
8
|
+
# To enable this hook, rename this file to "pre-commit".
|
|
9
|
+
|
|
10
|
+
if git rev-parse --verify HEAD >/dev/null 2>&1
|
|
11
|
+
then
|
|
12
|
+
against=HEAD
|
|
13
|
+
else
|
|
14
|
+
# Initial commit: diff against an empty tree object
|
|
15
|
+
against=$(git hash-object -t tree /dev/null)
|
|
16
|
+
fi
|
|
17
|
+
|
|
18
|
+
# If you want to allow non-ASCII filenames set this variable to true.
|
|
19
|
+
allownonascii=$(git config --type=bool hooks.allownonascii)
|
|
20
|
+
|
|
21
|
+
# Redirect output to stderr.
|
|
22
|
+
exec 1>&2
|
|
23
|
+
|
|
24
|
+
# Cross platform projects tend to avoid non-ASCII filenames; prevent
|
|
25
|
+
# them from being added to the repository. We exploit the fact that the
|
|
26
|
+
# printable range starts at the space character and ends with tilde.
|
|
27
|
+
if [ "$allownonascii" != "true" ] &&
|
|
28
|
+
# Note that the use of brackets around a tr range is ok here, (it's
|
|
29
|
+
# even required, for portability to Solaris 10's /usr/bin/tr), since
|
|
30
|
+
# the square bracket bytes happen to fall in the designated range.
|
|
31
|
+
test $(git diff-index --cached --name-only --diff-filter=A -z $against |
|
|
32
|
+
LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
|
|
33
|
+
then
|
|
34
|
+
cat <<\EOF
|
|
35
|
+
Error: Attempt to add a non-ASCII file name.
|
|
36
|
+
|
|
37
|
+
This can cause problems if you want to work with people on other platforms.
|
|
38
|
+
|
|
39
|
+
To be portable it is advisable to rename the file.
|
|
40
|
+
|
|
41
|
+
If you know what you are doing you can disable this check using:
|
|
42
|
+
|
|
43
|
+
git config hooks.allownonascii true
|
|
44
|
+
EOF
|
|
45
|
+
exit 1
|
|
46
|
+
fi
|
|
47
|
+
|
|
48
|
+
# If there are whitespace errors, print the offending file names and fail.
|
|
49
|
+
exec git diff-index --check --cached $against --
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# An example hook script to verify what is about to be committed.
|
|
4
|
+
# Called by "git merge" with no arguments. The hook should
|
|
5
|
+
# exit with non-zero status after issuing an appropriate message to
|
|
6
|
+
# stderr if it wants to stop the merge commit.
|
|
7
|
+
#
|
|
8
|
+
# To enable this hook, rename this file to "pre-merge-commit".
|
|
9
|
+
|
|
10
|
+
. git-sh-setup
|
|
11
|
+
test -x "$GIT_DIR/hooks/pre-commit" &&
|
|
12
|
+
exec "$GIT_DIR/hooks/pre-commit"
|
|
13
|
+
:
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
|
|
3
|
+
# An example hook script to verify what is about to be pushed. Called by "git
|
|
4
|
+
# push" after it has checked the remote status, but before anything has been
|
|
5
|
+
# pushed. If this script exits with a non-zero status nothing will be pushed.
|
|
6
|
+
#
|
|
7
|
+
# This hook is called with the following parameters:
|
|
8
|
+
#
|
|
9
|
+
# $1 -- Name of the remote to which the push is being done
|
|
10
|
+
# $2 -- URL to which the push is being done
|
|
11
|
+
#
|
|
12
|
+
# If pushing without using a named remote those arguments will be equal.
|
|
13
|
+
#
|
|
14
|
+
# Information about the commits which are being pushed is supplied as lines to
|
|
15
|
+
# the standard input in the form:
|
|
16
|
+
#
|
|
17
|
+
# <local ref> <local oid> <remote ref> <remote oid>
|
|
18
|
+
#
|
|
19
|
+
# This sample shows how to prevent push of commits where the log message starts
|
|
20
|
+
# with "WIP" (work in progress).
|
|
21
|
+
|
|
22
|
+
remote="$1"
|
|
23
|
+
url="$2"
|
|
24
|
+
|
|
25
|
+
zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
|
|
26
|
+
|
|
27
|
+
while read local_ref local_oid remote_ref remote_oid
|
|
28
|
+
do
|
|
29
|
+
if test "$local_oid" = "$zero"
|
|
30
|
+
then
|
|
31
|
+
# Handle delete
|
|
32
|
+
:
|
|
33
|
+
else
|
|
34
|
+
if test "$remote_oid" = "$zero"
|
|
35
|
+
then
|
|
36
|
+
# New branch, examine all commits
|
|
37
|
+
range="$local_oid"
|
|
38
|
+
else
|
|
39
|
+
# Update to existing branch, examine new commits
|
|
40
|
+
range="$remote_oid..$local_oid"
|
|
41
|
+
fi
|
|
42
|
+
|
|
43
|
+
# Check for WIP commit
|
|
44
|
+
commit=$(git rev-list -n 1 --grep '^WIP' "$range")
|
|
45
|
+
if test -n "$commit"
|
|
46
|
+
then
|
|
47
|
+
echo >&2 "Found WIP commit in $local_ref, not pushing"
|
|
48
|
+
exit 1
|
|
49
|
+
fi
|
|
50
|
+
fi
|
|
51
|
+
done
|
|
52
|
+
|
|
53
|
+
exit 0
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# Copyright (c) 2006, 2008 Junio C Hamano
|
|
4
|
+
#
|
|
5
|
+
# The "pre-rebase" hook is run just before "git rebase" starts doing
|
|
6
|
+
# its job, and can prevent the command from running by exiting with
|
|
7
|
+
# non-zero status.
|
|
8
|
+
#
|
|
9
|
+
# The hook is called with the following parameters:
|
|
10
|
+
#
|
|
11
|
+
# $1 -- the upstream the series was forked from.
|
|
12
|
+
# $2 -- the branch being rebased (or empty when rebasing the current branch).
|
|
13
|
+
#
|
|
14
|
+
# This sample shows how to prevent topic branches that are already
|
|
15
|
+
# merged to 'next' branch from getting rebased, because allowing it
|
|
16
|
+
# would result in rebasing already published history.
|
|
17
|
+
|
|
18
|
+
publish=next
|
|
19
|
+
basebranch="$1"
|
|
20
|
+
if test "$#" = 2
|
|
21
|
+
then
|
|
22
|
+
topic="refs/heads/$2"
|
|
23
|
+
else
|
|
24
|
+
topic=`git symbolic-ref HEAD` ||
|
|
25
|
+
exit 0 ;# we do not interrupt rebasing detached HEAD
|
|
26
|
+
fi
|
|
27
|
+
|
|
28
|
+
case "$topic" in
|
|
29
|
+
refs/heads/??/*)
|
|
30
|
+
;;
|
|
31
|
+
*)
|
|
32
|
+
exit 0 ;# we do not interrupt others.
|
|
33
|
+
;;
|
|
34
|
+
esac
|
|
35
|
+
|
|
36
|
+
# Now we are dealing with a topic branch being rebased
|
|
37
|
+
# on top of master. Is it OK to rebase it?
|
|
38
|
+
|
|
39
|
+
# Does the topic really exist?
|
|
40
|
+
git show-ref -q "$topic" || {
|
|
41
|
+
echo >&2 "No such branch $topic"
|
|
42
|
+
exit 1
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
# Is topic fully merged to master?
|
|
46
|
+
not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
|
|
47
|
+
if test -z "$not_in_master"
|
|
48
|
+
then
|
|
49
|
+
echo >&2 "$topic is fully merged to master; better remove it."
|
|
50
|
+
exit 1 ;# we could allow it, but there is no point.
|
|
51
|
+
fi
|
|
52
|
+
|
|
53
|
+
# Is topic ever merged to next? If so you should not be rebasing it.
|
|
54
|
+
only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
|
|
55
|
+
only_next_2=`git rev-list ^master ${publish} | sort`
|
|
56
|
+
if test "$only_next_1" = "$only_next_2"
|
|
57
|
+
then
|
|
58
|
+
not_in_topic=`git rev-list "^$topic" master`
|
|
59
|
+
if test -z "$not_in_topic"
|
|
60
|
+
then
|
|
61
|
+
echo >&2 "$topic is already up to date with master"
|
|
62
|
+
exit 1 ;# we could allow it, but there is no point.
|
|
63
|
+
else
|
|
64
|
+
exit 0
|
|
65
|
+
fi
|
|
66
|
+
else
|
|
67
|
+
not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
|
|
68
|
+
/usr/bin/perl -e '
|
|
69
|
+
my $topic = $ARGV[0];
|
|
70
|
+
my $msg = "* $topic has commits already merged to public branch:\n";
|
|
71
|
+
my (%not_in_next) = map {
|
|
72
|
+
/^([0-9a-f]+) /;
|
|
73
|
+
($1 => 1);
|
|
74
|
+
} split(/\n/, $ARGV[1]);
|
|
75
|
+
for my $elem (map {
|
|
76
|
+
/^([0-9a-f]+) (.*)$/;
|
|
77
|
+
[$1 => $2];
|
|
78
|
+
} split(/\n/, $ARGV[2])) {
|
|
79
|
+
if (!exists $not_in_next{$elem->[0]}) {
|
|
80
|
+
if ($msg) {
|
|
81
|
+
print STDERR $msg;
|
|
82
|
+
undef $msg;
|
|
83
|
+
}
|
|
84
|
+
print STDERR " $elem->[1]\n";
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
' "$topic" "$not_in_next" "$not_in_master"
|
|
88
|
+
exit 1
|
|
89
|
+
fi
|
|
90
|
+
|
|
91
|
+
<<\DOC_END
|
|
92
|
+
|
|
93
|
+
This sample hook safeguards topic branches that have been
|
|
94
|
+
published from being rewound.
|
|
95
|
+
|
|
96
|
+
The workflow assumed here is:
|
|
97
|
+
|
|
98
|
+
* Once a topic branch forks from "master", "master" is never
|
|
99
|
+
merged into it again (either directly or indirectly).
|
|
100
|
+
|
|
101
|
+
* Once a topic branch is fully cooked and merged into "master",
|
|
102
|
+
it is deleted. If you need to build on top of it to correct
|
|
103
|
+
earlier mistakes, a new topic branch is created by forking at
|
|
104
|
+
the tip of the "master". This is not strictly necessary, but
|
|
105
|
+
it makes it easier to keep your history simple.
|
|
106
|
+
|
|
107
|
+
* Whenever you need to test or publish your changes to topic
|
|
108
|
+
branches, merge them into "next" branch.
|
|
109
|
+
|
|
110
|
+
The script, being an example, hardcodes the publish branch name
|
|
111
|
+
to be "next", but it is trivial to make it configurable via
|
|
112
|
+
$GIT_DIR/config mechanism.
|
|
113
|
+
|
|
114
|
+
With this workflow, you would want to know:
|
|
115
|
+
|
|
116
|
+
(1) ... if a topic branch has ever been merged to "next". Young
|
|
117
|
+
topic branches can have stupid mistakes you would rather
|
|
118
|
+
clean up before publishing, and things that have not been
|
|
119
|
+
merged into other branches can be easily rebased without
|
|
120
|
+
affecting other people. But once it is published, you would
|
|
121
|
+
not want to rewind it.
|
|
122
|
+
|
|
123
|
+
(2) ... if a topic branch has been fully merged to "master".
|
|
124
|
+
Then you can delete it. More importantly, you should not
|
|
125
|
+
build on top of it -- other people may already want to
|
|
126
|
+
change things related to the topic as patches against your
|
|
127
|
+
"master", so if you need further changes, it is better to
|
|
128
|
+
fork the topic (perhaps with the same name) afresh from the
|
|
129
|
+
tip of "master".
|
|
130
|
+
|
|
131
|
+
Let's look at this example:
|
|
132
|
+
|
|
133
|
+
o---o---o---o---o---o---o---o---o---o "next"
|
|
134
|
+
/ / / /
|
|
135
|
+
/ a---a---b A / /
|
|
136
|
+
/ / / /
|
|
137
|
+
/ / c---c---c---c B /
|
|
138
|
+
/ / / \ /
|
|
139
|
+
/ / / b---b C \ /
|
|
140
|
+
/ / / / \ /
|
|
141
|
+
---o---o---o---o---o---o---o---o---o---o---o "master"
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
A, B and C are topic branches.
|
|
145
|
+
|
|
146
|
+
* A has one fix since it was merged up to "next".
|
|
147
|
+
|
|
148
|
+
* B has finished. It has been fully merged up to "master" and "next",
|
|
149
|
+
and is ready to be deleted.
|
|
150
|
+
|
|
151
|
+
* C has not merged to "next" at all.
|
|
152
|
+
|
|
153
|
+
We would want to allow C to be rebased, refuse A, and encourage
|
|
154
|
+
B to be deleted.
|
|
155
|
+
|
|
156
|
+
To compute (1):
|
|
157
|
+
|
|
158
|
+
git rev-list ^master ^topic next
|
|
159
|
+
git rev-list ^master next
|
|
160
|
+
|
|
161
|
+
if these match, topic has not merged in next at all.
|
|
162
|
+
|
|
163
|
+
To compute (2):
|
|
164
|
+
|
|
165
|
+
git rev-list master..topic
|
|
166
|
+
|
|
167
|
+
if this is empty, it is fully merged to "master".
|
|
168
|
+
|
|
169
|
+
DOC_END
|