Session Auto-Commit利用 GitHub Copilot Hooks 在会话结束时自动提交并推送代码【免费下载链接】awesome-copilotCommunity-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-copilotCopilot coding agent 在会话中会修改大量文件一旦会话结束未提交的改动可能散落在工作区中存在丢失风险。本指南围绕 awesome-copilot 仓库中的 Session Auto-Commit Hook 展开讲解如何基于 GitHub Copilot 的sessionEnd事件自动完成「检测改动 → 暂存 → 时间戳提交 → 推送远端」的完整流程并深入剖析其 Bash 脚本实现、hooks.json配置字段与可定制方向。读完本文你将掌握一套零手工干预的会话备份机制并理解 Copilot Hooks 的安装、配置与运行契约。概述这个 Hook 做什么Session Auto-Commit 是一个运行在 Copilot coding agent 会话结束时的命令型 Hook其核心目标是只要 agent 在会话期间产生了改动就自动提交并推送到远端确保工作永不丢失。根据仓库中的 README该 Hook 会自动执行以下操作检测是否存在未提交的改动uncommitted changes暂存全部改动stage all changes创建一个带时间戳的提交timestamped commit推送到远端仓库push to the remote repository它带来的四个核心价值点自动备份Automatic BackupCopilot 会话产出的工作不会因会话结束而丢失时间戳提交Timestamped Commits每个自动提交都包含会话结束时间便于回溯「哪次会话改了什么」安全执行Safe Execution只有存在实际改动时才提交无改动时静默退出不产生空提交错误处理Error Handling推送失败时优雅降级——改动仍保留在本地提交中不会阻塞会话结束。该 Hook 位于 hooks/session-auto-commit/由三个文件组成README.md使用文档、hooks.jsonHook 配置、auto-commit.shBash 实现脚本。前置知识Copilot Hooks 与事件模型在动手安装前先理解 Hook 的定位。根据仓库的 Hooks 总览文档Hooks 是「由 Copilot coding agent 会话中的特定事件触发的自动化工作流」支持的事件包括sessionStart、sessionEnd、userPromptSubmitted、preToolUse、postToolUse、errorOccurred等。每个 Hook 是一个文件夹包含README.md和hooks.json配置可能还附带辅助脚本。Session Auto-Commit 挂在sessionEnd事件上属于「会话收尾类」Hook。同类会话结束事件下的 Hook 还有Dependency License Checker会话结束时扫描新增依赖的许可证合规性check-licenses.shSecrets Scanner会话结束时扫描会话期间被修改的文件是否泄露密钥scan-secrets.shSession Logger记录会话活动用于审计与分析。它们与 Session Auto-Commit 可以组合使用——例如会话结束时先扫描密钥、再自动提交形成完整的收尾流水线。安装三步接入你的仓库按照 Session Auto-Commit README 的安装说明接入流程分为三步第一步拷贝 Hook 文件夹到目标仓库cp -r hooks/session-auto-commit .github/hooks/Copilot Hooks 的约定存放位置是仓库内的.github/hooks/目录每个 Hook 独立一个子目录参见 instructions/hooks.instructions.md 中的目录结构规范。第二步确保脚本可执行chmod x .github/hooks/session-auto-commit/auto-commit.shauto-commit.sh 以#!/bin/bash开头若缺少可执行权限Hook 宿主将无法运行它。第三步提交到默认分支将 Hook 配置提交到仓库的默认分支。这一点很关键——根据 instructions/hooks.instructions.md 的说明云 agentcloud agent只会从仓库默认分支加载 Hooks如果hooks.json只存在于功能分支上云 agent 将无法感知到它。配置hooks.json 逐字段解析该 Hook 的配置位于 hooks/session-auto-commit/hooks.json完整内容如下{ version: 1, hooks: { sessionEnd: [ { type: command, bash: .github/hooks/session-auto-commit/auto-commit.sh, timeoutSec: 30 } ] } }对照 instructions/hooks.instructions.md 中的配置字段说明各字段含义如下字段必填作用version是配置格式版本当前为1hooks是事件名到 Hook 条目数组的映射如sessionEndtype是Hook 类型command表示执行本地脚本bash是bash/powershell 至少其一在 Unix / Bash 宿主上执行的命令行powershell是bash/powershell 至少其一在 Windows / PowerShell 宿主上执行的命令行本 Hook 未提供说明其设计面向 Bash 环境cwd否工作目录相对于仓库根目录缺省时用宿主默认值timeoutSec否宿主终止脚本前的最大等待秒数默认 30本 Hook 显式配置为 30env否以进程环境变量形式传入脚本的额外静态配置值得注意的一点脚本路径写为.github/hooks/session-auto-commit/auto-commit.sh这与 README 中安装到.github/hooks/的步骤一致。如果你的仓库将 Hook 安装在别的路径需要同步修改bash字段。此外timeoutSec: 30意味着git push必须在 30 秒内完成或被宿主终止——这对慢速网络环境是潜在的调优点可以按需增大。原理auto-commit.sh 源码逐段剖析脚本实现位于 hooks/session-auto-commit/auto-commit.sh。它遵循「小而确定」的 Hook 设计原则全程不读取 stdin 事件 JSONsessionEnd事件对 stdout 没有结构化要求属于收尾型 Hook只依赖 Git 自身状态。我们逐段拆解。1. 严格模式与跳过开关#!/bin/bash set -euo pipefail # Check if SKIP_AUTO_COMMIT is set if [[ ${SKIP_AUTO_COMMIT:-} true ]]; then echo ⏭️ Auto-commit skipped (SKIP_AUTO_COMMITtrue) exit 0 fiset -euo pipefail是 instructions/hooks.instructions.md 推荐的 Bash 严格模式遇到错误立即退出、未定义变量报错、管道中任一环节失败即失败。脚本开头检查环境变量SKIP_AUTO_COMMIT为true时直接退出——这是 README 中「临时禁用」方案的实现基础。2. Git 仓库与改动检测# Check if were in a git repository if ! git rev-parse --is-inside-work-tree /dev/null; then echo ⚠️ Not in a git repository exit 0 fi # Check for uncommitted changes if [[ -z $(git status --porcelain) ]]; then echo ✨ No changes to commit exit 0 fi两重防御性检查用git rev-parse --is-inside-work-tree确认当前目录处于 Git 工作树内否则直接退出避免在非仓库目录报错刷屏用git status --porcelain检测未提交改动输出为空则说明工作区干净直接以「No changes to commit」退出——这正是 README「只在确有改动时才提交」特性的实现。--porcelain是面向脚本的机器可读输出格式比人类可读的git status更适合做空值判断。3. 暂存与时间戳提交echo Auto-committing changes from Copilot session... # Stage all changes git add -A # Create timestamped commit TIMESTAMP$(date %Y-%m-%d %H:%M:%S) git commit -m auto-commit: $TIMESTAMP --no-verify 2/dev/null || { echo ⚠️ Commit failed exit 0 }git add -A暂存所有改动包括新增、修改、删除的文件提交信息格式为auto-commit: YYYY-MM-DD HH:MM:SS例如auto-commit: 2026-09-09 18:05:32--no-verify绕过仓库自身的 pre-commit 钩子避免用户的 pre-commit 检查如 lint、格式化阻塞自动提交——这是 README「Notes」中明确说明的设计取舍提交失败例如配置了 user.name/user.email 缺失导致的提交报错时捕获错误并输出「Commit failed」后以 0 退出保证不会因提交失败影响会话结束流程。4. 推送与降级处理# Attempt to push if git push 2/dev/null; then echo ✅ Changes committed and pushed successfully else echo ⚠️ Push failed - changes committed locally fi exit 0推送成功输出确认信息推送失败网络问题、认证失败、远端冲突等则提示「Push failed - changes committed locally」——改动已留在本地提交中随时可以手动git push补救。无论成败脚本最终都返回exit 0呼应 README 中的承诺「失败的推送不会阻塞会话终止」。5. 完整运行时序结合 instructions/hooks.instructions.md 对sessionEnd事件的说明一次完整执行链路如下Copilot coding agent 会话结束宿主触发sessionEnd事件事件 payload 包含timestamp、cwd、reason等字段其中reason可取complete、error、abort、timeout、user_exit宿主执行hooks.json中sessionEnd数组内的命令型 Hook即bash .github/hooks/session-auto-commit/auto-commit.sh最长等待 30 秒脚本依次完成跳过开关检查 → Git 仓库检查 → 改动检测 →git add -A→git commit --no-verify→git push脚本输出人类可读的进度信息返回exit 0会话正常收尾。定制根据团队工作流改造README 明确指出可以从四个方面定制 auto-commit.sh。下面给出可直接落地的示例。定制提交信息格式时间戳格式与信息前缀都集中在提交语句中可以自由调整# 更精确到秒级毫秒或改为日期 会话编号 TIMESTAMP$(date %Y%m%d-%H%M%S) git commit -m chore(copilot): auto-save $TIMESTAMP --no-verify也可以结合sessionEnd事件的 payload 信息读取传入 stdin 的 JSON 中的reason字段拼入提交信息payload$(cat) reason$(printf %s $payload | jq -r .reason // unknown) git commit -m auto-commit: $TIMESTAMP (session: $reason) --no-verify选择性暂存不想把所有改动一股脑提交时把git add -A换成精确的路径模式git add src/ tests/ docs/ # 或排除特定目录 git add -A :!node_modules :!dist注意修改暂存策略后README「Safe Execution」特性只在有改动时提交依然生效因为脚本先通过git status --porcelain判断全局是否有改动。仅推送到特定分支默认的git push会推送到当前分支的上游。如需限制推送范围可加上分支判断CURRENT_BRANCH$(git rev-parse --abbrev-ref HEAD) if [[ $CURRENT_BRANCH main || $CURRENT_BRANCH develop ]]; then git push origin $CURRENT_BRANCH 2/dev/null || echo ⚠️ Push failed else echo ℹ️ Skipping push on branch: $CURRENT_BRANCH fi增加通知在推送成功或失败分支里接入通知渠道例如发送桌面通知或 Slack 消息if git push 2/dev/null; then echo ✅ Changes committed and pushed successfully command -v notify-send /dev/null notify-send Copilot Auto-commit pushed ✓ else echo ⚠️ Push failed - changes committed locally command -v notify-send /dev/null notify-send -u critical Copilot Auto-commit push failed fi更推荐的做法是把通知开关做成env配置。参照 instructions/hooks.instructions.md 对env字段的说明在 hooks.json 中静态注入开关脚本通过环境变量读取从而让同一份脚本在不同仓库表现不同无需改代码{ version: 1, hooks: { sessionEnd: [ { type: command, bash: .github/hooks/session-auto-commit/auto-commit.sh, cwd: ., timeoutSec: 30, env: { ENABLE_NOTIFICATIONS: true, SKIP_AUTO_COMMIT: false } } ] } }禁用两种临时关闭方式README 提供了两种临时禁用方案都不需要删除文件方式一注释或移除sessionEnd配置。编辑 hooks.json删除hooks对象中的sessionEnd键或整个文件改名重启会话后 Hook 即不再触发。方式二设置环境变量。在运行 Copilot 的 shell 中导出变量后脚本会在第一步直接跳过export SKIP_AUTO_COMMITtrue这一机制在 auto-commit.sh 的开头有明确的实现对应输出⏭️ Auto-commit skipped后exit 0适合临时不想要自动提交、但又不想动配置文件的场景。注意事项与适用边界综合 README 的 Notes 与脚本实现使用前请确认以下几点--no-verify是有意为之自动提交会绕过你仓库的 pre-commit 钩子。这意味着 pre-commit 中配置的格式校验、密钥扫描等不会在自动提交时执行——如果你的团队把安全检查放在 pre-commit 里建议与 Secrets Scanner 等会话级扫描 Hook 配合使用推送失败不阻塞会话push 失败时改动留在本地提交中需要人工补推网络不稳或认证过期时要注意这一点需要提前配置好 Git 凭据脚本本身不处理认证远端推送依赖已配置的 credential helper、SSH key 或 PAT同时适配两种客户端README 声明该 Hook 同时适用于 Copilot coding agent 与 GitHub Copilot CLI根据 instructions/hooks.instructions.md 的说明同一份.github/hooks/*.json配置与脚本契约在 CLI、VS Code 和云 agent 之间是通用的但云 agent 只加载默认分支上的 Hook提交用户身份依赖 Git 配置自动提交会使用仓库全局/本地配置的user.name与user.email未配置时git commit将失败脚本会以「Commit failed」优雅退出遵循 Hook 通用设计规则Hook 运行在会话收尾的关键路径上应保持同步、有界、非交互本 Hook 的 30 秒超时与纯 Git 操作符合这一约束。小结Session Auto-Commit 是 Copilot Hooks「会话收尾自动化」的典型范例一个不超过 45 行的 Bash 脚本加上 11 行的hooks.json配置就实现了「会话结束即备份」的可靠性保障。其脚本在 hooks/session-auto-commit/auto-commit.sh配置在 hooks/session-auto-commit/hooks.json安装总览可参考 docs/README.hooks.mdHook 编写的完整规范见 instructions/hooks.instructions.md。在安全执行、优雅降级与时间戳追溯三个维度上它为「如何编写一个合格的 Copilot Hook」提供了可直接复用的参考实现。【免费下载链接】awesome-copilotCommunity-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-copilot创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考