mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-30 12:15:56 +00:00
Update Learning Hub: HTTP hooks, preToolUse matcher, plugin install improvements (#1525)
- Document new HTTP hook type (v1.0.35): hooks can now POST JSON to a URL instead of running a local command, enabling centralized audit/notification services without distributing scripts to every developer's machine - Document preToolUse matcher field (v1.0.36): clarify that matcher is a regex filter on tool name; add important upgrade note about v1.0.36 behavioral fix (previously matcher was silently ignored) - Update Security Gating example to show matcher field targeting the bash tool - Add HTTP hook practical example for session-end audit webhook - Note that plugins take effect immediately after install (v1.0.35, no restart needed) - Update lastUpdated dates on both pages Sources: - https://github.com/github/copilot-cli/releases/tag/v1.0.35 - https://github.com/github/copilot-cli/releases/tag/v1.0.36 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
4b13306427
commit
f7a7ef7c28
@@ -3,7 +3,7 @@ title: 'Automating with Hooks'
|
||||
description: 'Learn how to use hooks to automate lifecycle events like formatting, linting, and governance checks during Copilot agent sessions.'
|
||||
authors:
|
||||
- GitHub Copilot Learning Hub Team
|
||||
lastUpdated: 2026-04-16
|
||||
lastUpdated: 2026-04-27
|
||||
estimatedReadingTime: '8 minutes'
|
||||
tags:
|
||||
- hooks
|
||||
@@ -156,13 +156,16 @@ This makes it straightforward to write plugin hooks that are portable across mac
|
||||
|
||||
### Event Configuration
|
||||
|
||||
Each hook entry supports these fields:
|
||||
Hooks support two types: `"command"` for running local shell scripts, and `"http"` for sending JSON payloads to a URL.
|
||||
|
||||
#### Shell command hooks (`type: "command"`)
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "command",
|
||||
"bash": "./scripts/my-check.sh",
|
||||
"powershell": "./scripts/my-check.ps1",
|
||||
"matcher": "^bash$",
|
||||
"cwd": ".",
|
||||
"timeoutSec": 10,
|
||||
"env": {
|
||||
@@ -171,18 +174,42 @@ Each hook entry supports these fields:
|
||||
}
|
||||
```
|
||||
|
||||
**type**: Always `"command"` for shell-based hooks.
|
||||
**type**: `"command"` for shell-based hooks.
|
||||
|
||||
**bash**: The command or script to execute on Unix systems. Can be inline or reference a script file.
|
||||
|
||||
**powershell**: The command or script to execute on Windows systems. Either `bash` or `powershell` (or both) must be provided.
|
||||
|
||||
**matcher** *(optional)*: A regular expression matched against the tool name. When present, the hook only fires for tools whose name fully matches the regex. For example, `"^bash$"` ensures the hook only runs for the `bash` tool, not for `edit` or other tools. This is particularly useful for `preToolUse` and `postToolUse` hooks where you want to target a specific tool.
|
||||
|
||||
> **Important (v1.0.36+)**: Prior to v1.0.36, the `matcher` field was silently ignored — hooks with a `matcher` fired for all tool calls regardless of the regex. After upgrading to v1.0.36 or later, only tool calls whose name fully matches the `matcher` regex will trigger the hook. Review any existing `preToolUse`/`postToolUse` hooks that use `matcher` to ensure they still fire as expected.
|
||||
|
||||
**cwd**: Working directory for the command (relative to repository root).
|
||||
|
||||
**timeoutSec**: Maximum execution time in seconds (default: 30). The hook is killed if it exceeds this limit.
|
||||
|
||||
**env**: Additional environment variables merged with the existing environment.
|
||||
|
||||
#### HTTP hooks (`type: "http"`)
|
||||
|
||||
Instead of running a local script, HTTP hooks POST a JSON payload to a configured URL. This is useful for integrating with webhooks, notification systems, or remote audit services — without needing a local script installed on every machine.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "http",
|
||||
"url": "https://your-server.example.com/hooks/copilot",
|
||||
"timeoutSec": 10
|
||||
}
|
||||
```
|
||||
|
||||
The hook sends an HTTP POST request with the same JSON context that command hooks receive via stdin (tool name, tool input, session information, etc.). If the server responds with a non-2xx status, the hook is treated as failed.
|
||||
|
||||
**url**: The URL to POST the JSON payload to.
|
||||
|
||||
**timeoutSec**: Maximum time in seconds to wait for the HTTP response (default: 30).
|
||||
|
||||
HTTP hooks are a lightweight way to fan out hook events to centralized logging or governance services without distributing scripts to every developer's machine.
|
||||
|
||||
### README.md
|
||||
|
||||
The README provides metadata and documentation for the Awesome Copilot repository. While not required in your own implementation, it serves as a useful way to document them for your team.
|
||||
@@ -312,7 +339,7 @@ If the lint command exits with a non-zero status, the action is blocked.
|
||||
|
||||
### Security Gating with preToolUse
|
||||
|
||||
Block dangerous commands before they execute:
|
||||
Block dangerous commands before they execute. Use the `matcher` field to target only the `bash` tool, so the hook doesn't fire for file edits or other tools:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -321,6 +348,7 @@ Block dangerous commands before they execute:
|
||||
"preToolUse": [
|
||||
{
|
||||
"type": "command",
|
||||
"matcher": "^bash$",
|
||||
"bash": "./scripts/security-check.sh",
|
||||
"cwd": ".",
|
||||
"timeoutSec": 15
|
||||
@@ -428,6 +456,27 @@ Send a Slack or Teams notification when an agent session completes:
|
||||
}
|
||||
```
|
||||
|
||||
### Notification on Session End via HTTP Hook
|
||||
|
||||
Send session activity to a remote audit endpoint using an HTTP hook (no local script needed):
|
||||
|
||||
```json
|
||||
{
|
||||
"version": 1,
|
||||
"hooks": {
|
||||
"sessionEnd": [
|
||||
{
|
||||
"type": "http",
|
||||
"url": "https://audit.example.com/copilot-sessions",
|
||||
"timeoutSec": 5
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The CLI POSTs the session context as JSON to the specified URL. This is ideal for centralized logging or compliance services that should receive events from all developers without requiring each person to install a local script.
|
||||
|
||||
### Injecting Context into Subagents
|
||||
|
||||
The `subagentStart` hook fires when the main agent spawns a subagent (e.g., via the `task` tool). Use it to inject additional context—such as project conventions or security guidelines—directly into the subagent's prompt:
|
||||
|
||||
@@ -3,7 +3,7 @@ title: 'Installing and Using Plugins'
|
||||
description: 'Learn how to find, install, and manage plugins that extend GitHub Copilot CLI with reusable agents, skills, hooks, and integrations.'
|
||||
authors:
|
||||
- GitHub Copilot Learning Hub Team
|
||||
lastUpdated: 2026-04-16
|
||||
lastUpdated: 2026-04-27
|
||||
estimatedReadingTime: '8 minutes'
|
||||
tags:
|
||||
- plugins
|
||||
@@ -223,7 +223,7 @@ When you install a plugin, its components become available to Copilot CLI automa
|
||||
- **Hooks** run at the configured lifecycle events during agent sessions
|
||||
- **MCP servers** extend the tools available to agents
|
||||
|
||||
You don't need to do any additional configuration after installing — the plugin's components integrate seamlessly into your workflow.
|
||||
You don't need to do any additional configuration after installing — the plugin's components integrate seamlessly into your workflow. Plugins take effect immediately after installation without requiring a Copilot CLI restart.
|
||||
|
||||
## Plugins from This Repository
|
||||
|
||||
|
||||
Reference in New Issue
Block a user