From da77169fab491fd562ab3fe48704f66212bcc840 Mon Sep 17 00:00:00 2001 From: Drew Ritter Date: Tue, 30 Jun 2026 14:08:40 -0700 Subject: [PATCH] Default Codex portal package to zip --- scripts/package-codex-plugin.sh | 128 +++++++++++++++++++---- tests/codex/test-package-codex-plugin.sh | 123 ++++++++++++++++++++-- 2 files changed, 221 insertions(+), 30 deletions(-) diff --git a/scripts/package-codex-plugin.sh b/scripts/package-codex-plugin.sh index 60be05d5..008644ed 100755 --- a/scripts/package-codex-plugin.sh +++ b/scripts/package-codex-plugin.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # -# Package the Superpowers Codex plugin as a rootless .tar.gz for portal upload. +# Package the Superpowers Codex plugin as a rootless archive for portal upload. # # The Codex portal artifact differs from the old openai/plugins sync flow: # it is a standalone archive, but it still needs the OpenAI-owned @@ -14,6 +14,7 @@ REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" REF="HEAD" OUTPUT="" +FORMAT="" METADATA_SOURCE="" ALLOW_DIRTY=0 KEEP_STAGE=0 @@ -25,18 +26,21 @@ Usage: Options: --output PATH Write archive to PATH. - Default: ../_tmp/sup-codex-packaging/superpowers-VERSION.tar.gz - --metadata-source PATH Prior official package directory or .tar.gz used to + Default: ../_tmp/sup-codex-packaging/superpowers-VERSION.zip + --format FORMAT Archive format: zip or tar.gz. Default: zip. + If --output ends in .zip, .tar.gz, or .tgz, that + extension is used when --format is omitted. + --metadata-source PATH Prior official package directory, .zip, or .tar.gz used to seed skills/*/agents/openai.yaml. Default: ../_tmp/sup-codex-packaging/superpowers, - falling back to ../_tmp/sup-codex-packaging/superpowers.tar.gz + falling back to superpowers.zip, then superpowers.tar.gz --ref REF Git ref to package. Default: HEAD. --allow-dirty Permit a dirty working tree. The archive still uses --ref. --keep-stage Print and keep the temporary staging directory. -h, --help Show this help. The archive is rootless: .codex-plugin/, assets/, skills/, README.md, LICENSE, -and CODE_OF_CONDUCT.md sit at the tar root. Source-only repo files, hooks, tests, +and CODE_OF_CONDUCT.md sit at the archive root. Source-only repo files, hooks, tests, docs, and other harness manifests are intentionally not shipped. EOF } @@ -53,6 +57,21 @@ while [[ $# -gt 0 ]]; do OUTPUT="$2" shift 2 ;; + --format) + [[ $# -ge 2 ]] || die "--format requires a value" + case "$2" in + zip) + FORMAT="zip" + ;; + tar.gz|tgz) + FORMAT="tar.gz" + ;; + *) + die "--format must be zip or tar.gz" + ;; + esac + shift 2 + ;; --metadata-source) [[ $# -ge 2 ]] || die "--metadata-source requires a path" METADATA_SOURCE="$2" @@ -83,11 +102,43 @@ while [[ $# -gt 0 ]]; do esac done +infer_format_from_output() { + local output_path="$1" + + case "$output_path" in + *.tar.gz|*.tgz) + printf '%s\n' "tar.gz" + ;; + *.zip) + printf '%s\n' "zip" + ;; + *) + return 1 + ;; + esac +} + +if [[ -z "$FORMAT" ]]; then + FORMAT="$(infer_format_from_output "$OUTPUT" || true)" + if [[ -z "$FORMAT" ]]; then + FORMAT="zip" + fi +else + output_format="$(infer_format_from_output "$OUTPUT" || true)" + if [[ -n "$output_format" && "$output_format" != "$FORMAT" ]]; then + die "--output extension does not match --format $FORMAT: $OUTPUT" + fi +fi + command -v git >/dev/null || die "git not found in PATH" command -v jq >/dev/null || die "jq not found in PATH" command -v tar >/dev/null || die "tar not found in PATH" command -v gzip >/dev/null || die "gzip not found in PATH" command -v shasum >/dev/null || die "shasum not found in PATH" +if [[ "$FORMAT" == "zip" ]]; then + command -v zip >/dev/null || die "zip not found in PATH" + command -v unzip >/dev/null || die "unzip not found in PATH" +fi [[ -d "$REPO_ROOT/.git" ]] || die "repo root is not a git checkout: $REPO_ROOT" git -C "$REPO_ROOT" rev-parse --verify "$REF^{commit}" >/dev/null || @@ -105,17 +156,19 @@ fi if [[ -z "$METADATA_SOURCE" ]]; then if [[ -d "$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers" ]]; then METADATA_SOURCE="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers" + elif [[ -f "$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.zip" ]]; then + METADATA_SOURCE="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.zip" elif [[ -f "$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.tar.gz" ]]; then METADATA_SOURCE="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.tar.gz" else - die "no metadata source found; pass --metadata-source " + die "no metadata source found; pass --metadata-source " fi fi WORK_DIR="$(mktemp -d "${TMPDIR:-/tmp}/superpowers-codex-package.XXXXXX")" STAGE="$WORK_DIR/payload" METADATA_WORK="$WORK_DIR/metadata" -TAR_LIST="$WORK_DIR/tar-list" +ARCHIVE_LIST="$WORK_DIR/archive-list" cleanup() { if [[ "$KEEP_STAGE" -eq 1 ]]; then @@ -158,8 +211,13 @@ prepare_metadata_root() { tar -xzf "$source" -C "$METADATA_WORK" root="$METADATA_WORK" ;; + *.zip) + command -v unzip >/dev/null || die "unzip not found in PATH" + unzip -q "$source" -d "$METADATA_WORK" + root="$METADATA_WORK" + ;; *) - die "metadata source must be a directory or .tar.gz: $source" + die "metadata source must be a directory, .zip, or .tar.gz: $source" ;; esac else @@ -189,7 +247,14 @@ if jq -e 'has("hooks")' "$STAGE/.codex-plugin/plugin.json" >/dev/null; then fi if [[ -z "$OUTPUT" ]]; then - OUTPUT="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers-$VERSION.tar.gz" + case "$FORMAT" in + zip) + OUTPUT="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers-$VERSION.zip" + ;; + tar.gz) + OUTPUT="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers-$VERSION.tar.gz" + ;; + esac fi mkdir -p "$(dirname "$OUTPUT")" OUTPUT="$(cd "$(dirname "$OUTPUT")" && pwd)/$(basename "$OUTPUT")" @@ -218,27 +283,51 @@ metadata_count="$(find "$STAGE/skills" -path '*/agents/openai.yaml' -type f | wc [[ "$skill_count" == "$metadata_count" ]] || die "metadata count mismatch: $metadata_count metadata files for $skill_count skills" -# Match the prior official archive's deterministic tar entry metadata. -TZ=UTC find "$STAGE" -exec touch -t 197001010000 {} + - ( cd "$STAGE" { find . -mindepth 1 -type d | sed 's#^\./##' | LC_ALL=C sort find . -mindepth 1 -type f | sed 's#^\./##' | LC_ALL=C sort - } >"$TAR_LIST" - - rm -f "$OUTPUT" - COPYFILE_DISABLE=1 tar -cf - --no-recursion --format ustar --uid 0 --gid 0 --uname '' --gname '' -T "$TAR_LIST" | - gzip -9n >"$OUTPUT" + } >"$ARCHIVE_LIST" ) +case "$FORMAT" in + zip) + # ZIP cannot represent dates earlier than 1980. + TZ=UTC find "$STAGE" -exec touch -t 198001010000 {} + + ( + cd "$STAGE" + rm -f "$OUTPUT" + COPYFILE_DISABLE=1 zip -X -q - -@ <"$ARCHIVE_LIST" >"$OUTPUT" + ) + ;; + tar.gz) + # Match the prior official archive's deterministic tar entry metadata. + TZ=UTC find "$STAGE" -exec touch -t 197001010000 {} + + ( + cd "$STAGE" + rm -f "$OUTPUT" + COPYFILE_DISABLE=1 tar -cf - --no-recursion --format ustar --uid 0 --gid 0 --uname '' --gname '' -T "$ARCHIVE_LIST" | + gzip -9n >"$OUTPUT" + ) + ;; +esac + if command -v xattr >/dev/null 2>&1; then xattr -c "$OUTPUT" 2>/dev/null || true fi +case "$FORMAT" in + zip) + archive_paths="$(unzip -Z1 "$OUTPUT" | sed 's#/$##')" + ;; + tar.gz) + archive_paths="$(tar -tzf "$OUTPUT")" + ;; +esac + unexpected_paths="$( - tar -tzf "$OUTPUT" | + printf '%s\n' "$archive_paths" | grep -E '(^superpowers/|^\.agents/|^hooks/|package\.json$|^\.git|^\.pytest_cache|^\.ruff_cache|^scripts/|^tests/|^docs/|^evals/|^lib/|^\.claude|^\.cursor|^\.kimi|^\.opencode|^\.pi|^AGENTS\.md$|^CLAUDE\.md$|^GEMINI\.md$|^RELEASE-NOTES\.md$|^CHANGELOG\.md$)' || true )" if [[ -n "$unexpected_paths" ]]; then @@ -246,10 +335,11 @@ if [[ -n "$unexpected_paths" ]]; then die "archive contains source-only paths" fi -entry_count="$(tar -tzf "$OUTPUT" | wc -l | tr -d ' ')" +entry_count="$(printf '%s\n' "$archive_paths" | wc -l | tr -d ' ')" checksum="$(shasum -a 256 "$OUTPUT" | awk '{print $1}')" echo "Archive: $OUTPUT" +echo "Format: $FORMAT" echo "Version: $VERSION" echo "Entries: $entry_count" echo "Skills: $skill_count" diff --git a/tests/codex/test-package-codex-plugin.sh b/tests/codex/test-package-codex-plugin.sh index 50be9ba7..d608674c 100755 --- a/tests/codex/test-package-codex-plugin.sh +++ b/tests/codex/test-package-codex-plugin.sh @@ -62,6 +62,61 @@ assert_not_matches() { fi } +list_archive() { + local archive_path="$1" + + case "$archive_path" in + *.tar.gz|*.tgz) + tar -tzf "$archive_path" + ;; + *.zip) + unzip -Z1 "$archive_path" + ;; + *) + unzip -Z1 "$archive_path" + ;; + esac +} + +normalize_archive_paths() { + sed 's#/$##' | LC_ALL=C sort +} + +extract_archive() { + local archive_path="$1" + local destination="$2" + + mkdir -p "$destination" + case "$archive_path" in + *.tar.gz|*.tgz) + tar -xzf "$archive_path" -C "$destination" + ;; + *.zip) + unzip -q "$archive_path" -d "$destination" + ;; + *) + unzip -q "$archive_path" -d "$destination" + ;; + esac +} + +read_archive_file() { + local archive_path="$1" + local file_path="$2" + + case "$archive_path" in + *.tar.gz|*.tgz) + tar -xOf "$archive_path" "$file_path" + ;; + *.zip) + unzip -p "$archive_path" "$file_path" + ;; + *) + unzip -p "$archive_path" "$file_path" + ;; + esac +} + write_metadata_fixture() { local destination="$1" local skill @@ -79,8 +134,10 @@ EOF echo "Codex package archive tests" metadata_source="$TEST_ROOT/metadata-source" -archive="$TEST_ROOT/superpowers.tar.gz" +archive="$TEST_ROOT/superpowers" +tar_archive="$TEST_ROOT/superpowers.tar.gz" extracted="$TEST_ROOT/extracted" +tar_extracted="$TEST_ROOT/tar-extracted" write_metadata_fixture "$metadata_source" if output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_source" --output "$archive" 2>&1)"; then @@ -97,12 +154,12 @@ else fi assert_contains "$output" "Archive:" "reports archive path" +assert_contains "$output" "Format: zip" "reports default zip format" assert_contains "$output" "SHA-256:" "reports archive checksum" -mkdir -p "$extracted" -tar -xzf "$archive" -C "$extracted" +extract_archive "$archive" "$extracted" -archive_paths="$(tar -tzf "$archive" | sort)" +archive_paths="$(list_archive "$archive" | normalize_archive_paths)" unexpected_pattern='(^superpowers/|^\.agents/|^hooks/|package\.json$|^\.git|^\.pytest_cache|^\.ruff_cache|^scripts/|^tests/|^docs/|^evals/|^lib/|^\.claude|^\.cursor|^\.kimi|^\.opencode|^\.pi|^AGENTS\.md$|^CLAUDE\.md$|^GEMINI\.md$|^RELEASE-NOTES\.md$|^CHANGELOG\.md$)' assert_not_matches "$archive_paths" "$unexpected_pattern" "archive excludes source-only paths" assert_contains "$archive_paths" ".codex-plugin/plugin.json" "archive includes Codex manifest" @@ -111,7 +168,7 @@ assert_contains "$archive_paths" "skills/brainstorming/agents/openai.yaml" "arch assert_contains "$archive_paths" "assets/app-icon.png" "archive includes app icon" assert_contains "$archive_paths" "assets/superpowers-small.svg" "archive includes composer icon" -manifest_summary="$(tar -xOf "$archive" .codex-plugin/plugin.json | python3 -c 'import json,sys; data=json.load(sys.stdin); print("\t".join([data["name"], data["version"], data["skills"], str(data.get("hooks"))]))')" +manifest_summary="$(read_archive_file "$archive" .codex-plugin/plugin.json | python3 -c 'import json,sys; data=json.load(sys.stdin); print("\t".join([data["name"], data["version"], data["skills"], str(data.get("hooks"))]))')" expected_version="$(python3 -c 'import json; print(json.load(open("'"$REPO_ROOT"'/.codex-plugin/plugin.json"))["version"])')" assert_equals "$manifest_summary" "superpowers $expected_version ./skills/ None" "archive manifest is current and hook-free" @@ -119,17 +176,48 @@ skill_count="$(find "$extracted/skills" -mindepth 1 -maxdepth 1 -type d | wc -l metadata_count="$(find "$extracted/skills" -path '*/agents/openai.yaml' -type f | wc -l | tr -d ' ')" assert_equals "$metadata_count" "$skill_count" "every packaged skill has OpenAI metadata" -task_brief_mode="$(tar -tzvf "$archive" skills/subagent-driven-development/scripts/task-brief | awk '{print $1}')" -assert_equals "$task_brief_mode" "-rwxr-xr-x" "archive preserves executable script mode" +if [[ -x "$extracted/skills/subagent-driven-development/scripts/task-brief" ]]; then + pass "archive preserves executable script mode" +else + fail "archive preserves executable script mode" +fi -metadata_times="$(tar -tzvf "$archive" | awk '{print $6, $7, $8}' | sort -u)" -assert_equals "$metadata_times" "Dec 31 1969" "archive normalizes entry timestamps" +zip_times="$(python3 - "$archive" <<'PY' +import sys +import zipfile + +with zipfile.ZipFile(sys.argv[1]) as archive: + print("\n".join(sorted({str(info.date_time) for info in archive.infolist()}))) +PY +)" +assert_equals "$zip_times" "(1980, 1, 1, 0, 0, 0)" "zip archive normalizes entry timestamps" + +if tar_output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_source" --format tar.gz --output "$tar_archive" 2>&1)"; then + pass "package script writes explicit tar.gz archive" +else + fail "package script writes explicit tar.gz archive" + printf '%s\n' "$tar_output" | sed 's/^/ /' +fi +assert_contains "$tar_output" "Format: tar.gz" "reports explicit tar.gz format" + +extract_archive "$tar_archive" "$tar_extracted" +tar_archive_paths="$(list_archive "$tar_archive" | normalize_archive_paths)" +assert_equals "$tar_archive_paths" "$archive_paths" "zip and tar.gz archives contain the same paths" + +tar_task_brief_mode="$(tar -tzvf "$tar_archive" skills/subagent-driven-development/scripts/task-brief | awk '{print $1}')" +assert_equals "$tar_task_brief_mode" "-rwxr-xr-x" "tar.gz archive preserves executable script mode" + +tar_metadata_times="$(tar -tzvf "$tar_archive" | awk '{print $6, $7, $8}' | sort -u)" +assert_equals "$tar_metadata_times" "Dec 31 1969" "tar.gz archive normalizes entry timestamps" metadata_archive="$TEST_ROOT/metadata-source.tar.gz" -archive_from_tar_source="$TEST_ROOT/superpowers-from-tar-source.tar.gz" +metadata_zip="$TEST_ROOT/metadata-source.zip" +archive_from_tar_source="$TEST_ROOT/superpowers-from-tar-source.zip" +archive_from_zip_source="$TEST_ROOT/superpowers-from-zip-source.zip" ( cd "$metadata_source" tar -czf "$metadata_archive" . + zip -X -q -r "$metadata_zip" . ) if output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_archive" --output "$archive_from_tar_source" 2>&1)"; then @@ -145,6 +233,19 @@ else fail "tarball metadata source produces identical archive" fi +if output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_zip" --output "$archive_from_zip_source" 2>&1)"; then + pass "package script accepts zip metadata source" +else + fail "package script accepts zip metadata source" + printf '%s\n' "$output" | sed 's/^/ /' +fi + +if cmp -s "$archive" "$archive_from_zip_source"; then + pass "zip metadata source produces identical archive" +else + fail "zip metadata source produces identical archive" +fi + incomplete_metadata="$TEST_ROOT/incomplete-metadata" mkdir -p "$incomplete_metadata/skills/brainstorming/agents" cp "$metadata_source/skills/brainstorming/agents/openai.yaml" \ @@ -169,7 +270,7 @@ dirty_output="$( cd "$dirty_repo" scripts/package-codex-plugin.sh \ --metadata-source "$metadata_source" \ - --output "$TEST_ROOT/dirty.tar.gz" 2>&1 + --output "$TEST_ROOT/dirty.zip" 2>&1 )" dirty_status=$? set -e