Skip to content

chore: enforce installer deployment dependency boundary #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuanyp8 merged 3 commits into from
Jun 21, 2026
Merged

chore: enforce installer deployment dependency boundary #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b211754
ci: forbid runtime-only tools in installers
yuanyp8 Jun 21, 2026
8e3df20
docs: clarify deployment environment requirements
yuanyp8 Jun 21, 2026
531c899
ci: avoid false positives for node-port installer option
yuanyp8 Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .github/workflows/offline-run.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
if: steps.filter.outputs.enabled == 'true'
uses: docker/setup-buildx-action@v3

- name: Install tools
- name: Install build tools
if: steps.filter.outputs.enabled == 'true'
run: |
sudo apt-get update
Expand All @@ -80,8 +80,16 @@ jobs:
cd "packages/${{ matrix.package }}"
build_script="build.sh"
if [[ -f build-fixed.sh ]]; then build_script="build-fixed.sh"; fi

bash -n "$build_script" install.sh
jq empty images/image.json

echo "Checking install.sh does not require non-baseline deployment tools"
if grep -En '(^|[[:space:];|&()])(jq|yq|python3|python|node|npm|npx)([[:space:];|&()]|$)' install.sh; then
echo "::error::install.sh must not depend on jq/yq/python/node/npm/npx. These are allowed in CI/build only, not in deployment environments."
exit 1
fi

bash "$build_script" --arch "${{ matrix.arch }}"

- name: Upload artifact
Expand Down
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ new-api-k8s-installer-arm64.run

推送 `v*` tag 时，会自动把 `.run` 与 `.sha256` 发布到 GitHub Release。

## 本地构建
## 构建侧依赖

本地需要 Docker Buildx、Git、jq、tar、sha256sum：
构建环境允许安装辅助工具。GitHub Actions 当前会安装 `jq`，用于校验 `images/image.json`。

本地构建需要 Docker Buildx、Git、jq、tar、sha256sum：

```bash
cd packages/compose
Expand All @@ -47,6 +49,19 @@ bash build.sh --arch amd64 --source-dir /path/to/new-api-main

`--source-dir` 可以直接指向上游源码目录；不传时会从 `SOURCE_REPO` 克隆。

## 现场部署侧依赖

现场部署环境不要求 `jq`、`yq`、`python`、`node`、`npm`、`npx` 等额外工具。

`.run install/status/uninstall/print-images` 只依赖基础 shell 工具和对应部署运行时：

- Compose 包：`bash`、`tar`、`sed`、`date`、`docker`，以及 `docker compose` 或 `docker-compose`。
- Kubernetes 包：`bash`、`tar`、`sed`、`date`、`docker`、`kubectl`。

镜像映射不在现场解析 JSON，而是读取构建阶段生成的 `images/image-index.tsv`。

CI 已增加保护：如果 `install.sh` 引入 `jq/yq/python/node/npm/npx`，构建会直接失败。

## Compose 现场安装

```bash
Expand Down
Loading