🔒 security(ci): keep sync token out of remote url via GIT_ASKPASS
- inline .gitea/ci/sync_tsl_playbook.sh into sync-tsl-playbook.yml - clone over plain repo url; credentials flow through an ephemeral GIT_ASKPASS helper removed in cleanup - rewrite tests to extract and exercise the workflow run block Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -1,80 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
# Build the minimal TSL playbook bundle and publish its *expanded* contents to
|
|
||||||
# the tsl-playbook branch. The branch tree mirrors the bundle root directly
|
|
||||||
# (AGENTS.md, docs/, skills/) — there is no wrapping tsl-playbook/ directory.
|
|
||||||
#
|
|
||||||
# Only the paths produced by the bundle are managed. Any other file that lives
|
|
||||||
# on the branch (e.g. a hand-written README.md) is preserved across syncs.
|
|
||||||
|
|
||||||
REPO_DIR="${REPO_DIR:-$(pwd)}"
|
|
||||||
TARGET_BRANCH="${TARGET_BRANCH:-tsl-playbook}"
|
|
||||||
BUILD_SCRIPT="${BUILD_SCRIPT:-scripts/build_tsl_playbook.py}"
|
|
||||||
COMMIT_AUTHOR_NAME="${COMMIT_AUTHOR_NAME:-ci[bot]}"
|
|
||||||
COMMIT_AUTHOR_EMAIL="${COMMIT_AUTHOR_EMAIL:-ci-bot@local}"
|
|
||||||
|
|
||||||
cd "$REPO_DIR"
|
|
||||||
|
|
||||||
git config user.name "$COMMIT_AUTHOR_NAME"
|
|
||||||
git config user.email "$COMMIT_AUTHOR_EMAIL"
|
|
||||||
|
|
||||||
source_sha="$(git rev-parse HEAD)"
|
|
||||||
source_short="$(git rev-parse --short HEAD)"
|
|
||||||
|
|
||||||
# Build the bundle into a temp dir *outside* the repo so that resetting the
|
|
||||||
# target branch's working tree can never clobber the freshly built artifact.
|
|
||||||
build_dir="$(mktemp -d)"
|
|
||||||
cleanup() {
|
|
||||||
rm -rf "$build_dir"
|
|
||||||
}
|
|
||||||
trap cleanup EXIT
|
|
||||||
|
|
||||||
bundle="$build_dir/tsl-playbook"
|
|
||||||
python3 "$BUILD_SCRIPT" --output "$bundle"
|
|
||||||
|
|
||||||
# These are the only paths this workflow owns on the branch. Everything else is
|
|
||||||
# left alone, including hand-written files such as README.md.
|
|
||||||
generated_paths=(AGENTS.md docs skills)
|
|
||||||
for path in "${generated_paths[@]}"; do
|
|
||||||
if [ ! -e "$bundle/$path" ]; then
|
|
||||||
echo "ERROR: bundle is missing expected path: $path" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Check out (or create) the target branch.
|
|
||||||
if git show-ref --verify --quiet "refs/remotes/origin/$TARGET_BRANCH"; then
|
|
||||||
git fetch origin "$TARGET_BRANCH"
|
|
||||||
git checkout -B "$TARGET_BRANCH" "origin/$TARGET_BRANCH"
|
|
||||||
else
|
|
||||||
# A brand-new orphan branch inherits main's index. Clear the index without
|
|
||||||
# deleting source files from the working tree; only generated_paths are staged.
|
|
||||||
git checkout --orphan "$TARGET_BRANCH"
|
|
||||||
git rm -rf --cached --quiet . >/dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Remove only generated paths before copying the freshly built bundle.
|
|
||||||
rm -rf "${generated_paths[@]}"
|
|
||||||
|
|
||||||
# Copy bundle contents (including dotfiles) to the repo root.
|
|
||||||
cp -R "$bundle"/. "$REPO_DIR"/
|
|
||||||
|
|
||||||
git add -A "${generated_paths[@]}"
|
|
||||||
|
|
||||||
if git diff --cached --quiet; then
|
|
||||||
echo "No tsl-playbook changes to publish."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
git commit -m ":package: deps(tsl): sync tsl-playbook from ${source_short}
|
|
||||||
|
|
||||||
Source-Commit: ${source_sha}"
|
|
||||||
|
|
||||||
TOKEN="${WORKFLOW:-}"
|
|
||||||
if [ -n "$TOKEN" ] && [ -n "${GITHUB_SERVER_URL:-}" ] && [ -n "${GITHUB_REPOSITORY:-}" ]; then
|
|
||||||
git remote set-url origin "https://oauth2:${TOKEN}@${GITHUB_SERVER_URL#https://}/${GITHUB_REPOSITORY}.git"
|
|
||||||
fi
|
|
||||||
|
|
||||||
git push origin "$TARGET_BRANCH"
|
|
||||||
echo "✅ Published tsl-playbook @ ${source_short}"
|
|
||||||
@@ -22,6 +22,8 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: 📥 准备仓库
|
- name: 📥 准备仓库
|
||||||
shell: bash
|
shell: bash
|
||||||
|
env:
|
||||||
|
WORKFLOW: ${{ secrets.WORKFLOW }}
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
@@ -30,15 +32,28 @@ jobs:
|
|||||||
echo "========================================"
|
echo "========================================"
|
||||||
|
|
||||||
REPO_NAME="${{ github.event.repository.name }}"
|
REPO_NAME="${{ github.event.repository.name }}"
|
||||||
TOKEN="${{ secrets.WORKFLOW }}"
|
|
||||||
mkdir -p "$WORKSPACE_DIR"
|
mkdir -p "$WORKSPACE_DIR"
|
||||||
REPO_DIR="$(mktemp -d "$WORKSPACE_DIR/${REPO_NAME}.XXXXXX")"
|
REPO_DIR="$(mktemp -d "$WORKSPACE_DIR/${REPO_NAME}.XXXXXX")"
|
||||||
if [ -n "$TOKEN" ]; then
|
export GIT_TERMINAL_PROMPT=0
|
||||||
REPO_URL="https://oauth2:${TOKEN}@${GITHUB_SERVER_URL#https://}/${GITHUB_REPOSITORY}.git"
|
echo "GIT_TERMINAL_PROMPT=0" >> "$GITHUB_ENV"
|
||||||
else
|
|
||||||
REPO_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
|
if [ -n "${WORKFLOW:-}" ]; then
|
||||||
|
ASKPASS_SCRIPT="$(mktemp "$WORKSPACE_DIR/git-askpass.XXXXXX")"
|
||||||
|
cat > "$ASKPASS_SCRIPT" <<'EOF'
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
case "$1" in
|
||||||
|
*Username*) printf '%s\n' oauth2 ;;
|
||||||
|
*Password*) printf '%s\n' "$WORKFLOW" ;;
|
||||||
|
*) printf '\n' ;;
|
||||||
|
esac
|
||||||
|
EOF
|
||||||
|
chmod 700 "$ASKPASS_SCRIPT"
|
||||||
|
export GIT_ASKPASS="$ASKPASS_SCRIPT"
|
||||||
|
echo "GIT_ASKPASS=$ASKPASS_SCRIPT" >> "$GITHUB_ENV"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
REPO_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
|
||||||
|
|
||||||
git clone "$REPO_URL" "$REPO_DIR"
|
git clone "$REPO_URL" "$REPO_DIR"
|
||||||
|
|
||||||
git -C "$REPO_DIR" fetch origin main
|
git -C "$REPO_DIR" fetch origin main
|
||||||
@@ -54,15 +69,74 @@ jobs:
|
|||||||
WORKFLOW: ${{ secrets.WORKFLOW }}
|
WORKFLOW: ${{ secrets.WORKFLOW }}
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
|
REPO_DIR="${REPO_DIR:-$(pwd)}"
|
||||||
|
TARGET_BRANCH="${TARGET_BRANCH:-tsl-playbook}"
|
||||||
|
BUILD_SCRIPT="${BUILD_SCRIPT:-scripts/build_tsl_playbook.py}"
|
||||||
|
COMMIT_AUTHOR_NAME="${COMMIT_AUTHOR_NAME:-ci[bot]}"
|
||||||
|
COMMIT_AUTHOR_EMAIL="${COMMIT_AUTHOR_EMAIL:-ci-bot@local}"
|
||||||
|
|
||||||
cd "$REPO_DIR"
|
cd "$REPO_DIR"
|
||||||
|
|
||||||
echo "========================================"
|
echo "========================================"
|
||||||
echo "🔨 Build bundle and sync $TARGET_BRANCH"
|
echo "🔨 Build bundle and sync $TARGET_BRANCH"
|
||||||
echo "========================================"
|
echo "========================================"
|
||||||
|
|
||||||
TARGET_BRANCH="$TARGET_BRANCH" bash .gitea/ci/sync_tsl_playbook.sh
|
git config user.name "$COMMIT_AUTHOR_NAME"
|
||||||
|
git config user.email "$COMMIT_AUTHOR_EMAIL"
|
||||||
|
|
||||||
|
source_sha="$(git rev-parse HEAD)"
|
||||||
|
source_short="$(git rev-parse --short HEAD)"
|
||||||
|
|
||||||
|
# Build the bundle outside the repo so branch checkout cannot clobber it.
|
||||||
|
build_dir="$(mktemp -d)"
|
||||||
|
cleanup() {
|
||||||
|
rm -rf "$build_dir"
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
bundle="$build_dir/tsl-playbook"
|
||||||
|
python3 "$BUILD_SCRIPT" --output "$bundle"
|
||||||
|
|
||||||
|
# These are the only paths this workflow owns on the target branch.
|
||||||
|
generated_paths=(AGENTS.md docs skills)
|
||||||
|
for path in "${generated_paths[@]}"; do
|
||||||
|
if [ ! -e "$bundle/$path" ]; then
|
||||||
|
echo "ERROR: bundle is missing expected path: $path" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if git show-ref --verify --quiet "refs/remotes/origin/$TARGET_BRANCH"; then
|
||||||
|
git fetch origin "$TARGET_BRANCH"
|
||||||
|
git checkout -B "$TARGET_BRANCH" "origin/$TARGET_BRANCH"
|
||||||
|
else
|
||||||
|
# A new orphan branch inherits main's index; clear it without deleting files.
|
||||||
|
git checkout --orphan "$TARGET_BRANCH"
|
||||||
|
git rm -rf --cached --quiet . >/dev/null 2>&1 || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
rm -rf "${generated_paths[@]}"
|
||||||
|
cp -R "$bundle"/. "$REPO_DIR"/
|
||||||
|
|
||||||
|
git add -A "${generated_paths[@]}"
|
||||||
|
|
||||||
|
if git diff --cached --quiet; then
|
||||||
|
echo "No tsl-playbook changes to publish."
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
git commit -m ":package: deps(tsl): sync tsl-playbook from ${source_short}
|
||||||
|
|
||||||
|
Source-Commit: ${source_sha}"
|
||||||
|
|
||||||
|
git push origin "$TARGET_BRANCH"
|
||||||
|
echo "✅ Published tsl-playbook @ ${source_short}"
|
||||||
|
|
||||||
- name: 🧹 清理临时仓库
|
- name: 🧹 清理临时仓库
|
||||||
if: always()
|
if: always()
|
||||||
run: |
|
run: |
|
||||||
|
if [ -n "${GIT_ASKPASS:-}" ]; then
|
||||||
|
rm -f "$GIT_ASKPASS"
|
||||||
|
fi
|
||||||
rm -rf "$REPO_DIR"
|
rm -rf "$REPO_DIR"
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
ROOT = Path(__file__).resolve().parents[1]
|
ROOT = Path(__file__).resolve().parents[1]
|
||||||
SCRIPT = ROOT / "scripts" / "build_tsl_playbook.py"
|
SCRIPT = ROOT / "scripts" / "build_tsl_playbook.py"
|
||||||
SYNC_SCRIPT = ROOT / ".gitea" / "ci" / "sync_tsl_playbook.sh"
|
SYNC_WORKFLOW = ROOT / ".gitea" / "workflows" / "sync-tsl-playbook.yml"
|
||||||
|
|
||||||
|
|
||||||
class BuildTslPlaybookTests(unittest.TestCase):
|
class BuildTslPlaybookTests(unittest.TestCase):
|
||||||
@@ -61,16 +61,23 @@ class BuildTslPlaybookTests(unittest.TestCase):
|
|||||||
output_skill = count_files(output / "skills" / "tsl-api-reference")
|
output_skill = count_files(output / "skills" / "tsl-api-reference")
|
||||||
self.assertEqual(output_skill, source_skill)
|
self.assertEqual(output_skill, source_skill)
|
||||||
|
|
||||||
def test_sync_script_does_not_remove_entire_target_branch(self):
|
def test_sync_workflow_does_not_remove_entire_target_branch(self):
|
||||||
text = SYNC_SCRIPT.read_text(encoding="utf-8")
|
text = SYNC_WORKFLOW.read_text(encoding="utf-8")
|
||||||
|
|
||||||
self.assertNotRegex(text, r"git rm -rf --quiet\s+\.")
|
self.assertNotRegex(text, r"git rm -rf --quiet\s+\.")
|
||||||
self.assertIn("generated_paths=(AGENTS.md docs skills)", text)
|
self.assertIn("generated_paths=(AGENTS.md docs skills)", text)
|
||||||
self.assertIn('git add -A "${generated_paths[@]}"', text)
|
self.assertIn('git add -A "${generated_paths[@]}"', text)
|
||||||
|
self.assertNotIn(".gitea/ci/", text)
|
||||||
|
self.assertNotIn("https://oauth2", text)
|
||||||
|
self.assertNotIn("oauth2:${TOKEN}", text)
|
||||||
|
self.assertNotRegex(text, r"REPO_URL=.*(TOKEN|WORKFLOW)")
|
||||||
|
self.assertNotIn("git remote set-url", text)
|
||||||
|
self.assertIn("GIT_ASKPASS", text)
|
||||||
|
self.assertIn('REPO_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"', text)
|
||||||
|
|
||||||
def test_sync_preserves_files_outside_generated_paths(self):
|
def test_sync_preserves_files_outside_generated_paths(self):
|
||||||
if shutil.which("bash") is None:
|
if shutil.which("bash") is None:
|
||||||
self.skipTest("bash is required to run sync_tsl_playbook.sh")
|
self.skipTest("bash is required to run sync workflow script")
|
||||||
|
|
||||||
with tempfile.TemporaryDirectory() as tmp_dir:
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
repo = create_source_repo(Path(tmp_dir))
|
repo = create_source_repo(Path(tmp_dir))
|
||||||
@@ -104,7 +111,7 @@ class BuildTslPlaybookTests(unittest.TestCase):
|
|||||||
|
|
||||||
def test_sync_creates_new_branch_without_source_files(self):
|
def test_sync_creates_new_branch_without_source_files(self):
|
||||||
if shutil.which("bash") is None:
|
if shutil.which("bash") is None:
|
||||||
self.skipTest("bash is required to run sync_tsl_playbook.sh")
|
self.skipTest("bash is required to run sync workflow script")
|
||||||
|
|
||||||
with tempfile.TemporaryDirectory() as tmp_dir:
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
||||||
repo = create_source_repo(Path(tmp_dir))
|
repo = create_source_repo(Path(tmp_dir))
|
||||||
@@ -119,7 +126,7 @@ class BuildTslPlaybookTests(unittest.TestCase):
|
|||||||
git(repo, "cat-file", "-e", f"HEAD:{path}")
|
git(repo, "cat-file", "-e", f"HEAD:{path}")
|
||||||
|
|
||||||
for path in (
|
for path in (
|
||||||
".gitea/ci/sync_tsl_playbook.sh",
|
".gitea/workflows/sync-tsl-playbook.yml",
|
||||||
"scripts/build_tsl_playbook.py",
|
"scripts/build_tsl_playbook.py",
|
||||||
"rulesets/tsl/index.md",
|
"rulesets/tsl/index.md",
|
||||||
):
|
):
|
||||||
@@ -159,22 +166,32 @@ def run_sync(repo: Path) -> None:
|
|||||||
"COMMIT_AUTHOR_EMAIL": "test@example.invalid",
|
"COMMIT_AUTHOR_EMAIL": "test@example.invalid",
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
result = subprocess.run(
|
with tempfile.NamedTemporaryFile(
|
||||||
["bash", ".gitea/ci/sync_tsl_playbook.sh"],
|
"w", suffix=".sh", encoding="utf-8", newline="\n", delete=False
|
||||||
cwd=repo,
|
) as script_file:
|
||||||
env=env,
|
script_file.write(extract_sync_workflow_script())
|
||||||
capture_output=True,
|
script_path = script_file.name
|
||||||
text=True,
|
try:
|
||||||
encoding="utf-8",
|
result = subprocess.run(
|
||||||
errors="replace",
|
["bash", script_path],
|
||||||
)
|
cwd=repo,
|
||||||
|
env=env,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
encoding="utf-8",
|
||||||
|
errors="replace",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
os.unlink(script_path)
|
||||||
if result.returncode != 0:
|
if result.returncode != 0:
|
||||||
raise AssertionError(result.stderr + result.stdout)
|
raise AssertionError(result.stderr + result.stdout)
|
||||||
|
|
||||||
|
|
||||||
def copy_required_sources(repo: Path) -> None:
|
def copy_required_sources(repo: Path) -> None:
|
||||||
(repo / ".gitea" / "ci").mkdir(parents=True)
|
(repo / ".gitea" / "workflows").mkdir(parents=True)
|
||||||
shutil.copy2(SYNC_SCRIPT, repo / ".gitea" / "ci" / "sync_tsl_playbook.sh")
|
shutil.copy2(
|
||||||
|
SYNC_WORKFLOW, repo / ".gitea" / "workflows" / "sync-tsl-playbook.yml"
|
||||||
|
)
|
||||||
|
|
||||||
(repo / "scripts").mkdir()
|
(repo / "scripts").mkdir()
|
||||||
shutil.copy2(SCRIPT, repo / "scripts" / "build_tsl_playbook.py")
|
shutil.copy2(SCRIPT, repo / "scripts" / "build_tsl_playbook.py")
|
||||||
@@ -203,6 +220,36 @@ def count_files(path: Path) -> int:
|
|||||||
return sum(1 for item in path.rglob("*") if item.is_file())
|
return sum(1 for item in path.rglob("*") if item.is_file())
|
||||||
|
|
||||||
|
|
||||||
|
def extract_sync_workflow_script() -> str:
|
||||||
|
lines = SYNC_WORKFLOW.read_text(encoding="utf-8").splitlines()
|
||||||
|
in_sync_step = False
|
||||||
|
in_run_block = False
|
||||||
|
script_lines: list[str] = []
|
||||||
|
|
||||||
|
for line in lines:
|
||||||
|
if line.startswith(" - name: 📦 Build and publish tsl-playbook"):
|
||||||
|
in_sync_step = True
|
||||||
|
continue
|
||||||
|
if in_sync_step and line.startswith(" - name: "):
|
||||||
|
break
|
||||||
|
if in_sync_step and line == " run: |":
|
||||||
|
in_run_block = True
|
||||||
|
continue
|
||||||
|
if not in_run_block:
|
||||||
|
continue
|
||||||
|
if line.startswith(" "):
|
||||||
|
script_lines.append(line[10:])
|
||||||
|
continue
|
||||||
|
if line.strip() == "":
|
||||||
|
script_lines.append("")
|
||||||
|
continue
|
||||||
|
break
|
||||||
|
|
||||||
|
if not script_lines:
|
||||||
|
raise AssertionError("sync workflow run block was not found")
|
||||||
|
return "\n".join(script_lines) + "\n"
|
||||||
|
|
||||||
|
|
||||||
def git(repo: Path, *args: str) -> subprocess.CompletedProcess[str]:
|
def git(repo: Path, *args: str) -> subprocess.CompletedProcess[str]:
|
||||||
return run(["git", *args], cwd=repo)
|
return run(["git", *args], cwd=repo)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user