@numa-tech/numa 1.12.8 → 1.12.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +140 -16
- package/dist/ai-registry/commands.js +33 -33
- package/dist/ai-registry/commands.js.map +1 -1
- package/dist/app-config.d.ts +0 -1
- package/dist/app-config.js +4 -2
- package/dist/app-config.js.map +1 -1
- package/dist/application-candidates/client.d.ts +167 -0
- package/dist/application-candidates/client.js +103 -0
- package/dist/application-candidates/client.js.map +1 -0
- package/dist/application-candidates/commands.d.ts +13 -0
- package/dist/application-candidates/commands.js +225 -0
- package/dist/application-candidates/commands.js.map +1 -0
- package/dist/application-candidates/schemas.d.ts +171 -0
- package/dist/application-candidates/schemas.js +80 -0
- package/dist/application-candidates/schemas.js.map +1 -0
- package/dist/application-onboarding/client.d.ts +256 -0
- package/dist/application-onboarding/client.js +213 -0
- package/dist/application-onboarding/client.js.map +1 -0
- package/dist/application-onboarding/commands.d.ts +64 -0
- package/dist/application-onboarding/commands.js +694 -0
- package/dist/application-onboarding/commands.js.map +1 -0
- package/dist/application-onboarding/errors.d.ts +11 -0
- package/dist/application-onboarding/errors.js +51 -0
- package/dist/application-onboarding/errors.js.map +1 -0
- package/dist/application-onboarding/schemas.d.ts +1167 -0
- package/dist/application-onboarding/schemas.js +459 -0
- package/dist/application-onboarding/schemas.js.map +1 -0
- package/dist/application-onboarding/scm-credentials.d.ts +8 -0
- package/dist/application-onboarding/scm-credentials.js +98 -0
- package/dist/application-onboarding/scm-credentials.js.map +1 -0
- package/dist/application-onboarding/tui-model.d.ts +131 -0
- package/dist/application-onboarding/tui-model.js +554 -0
- package/dist/application-onboarding/tui-model.js.map +1 -0
- package/dist/application-onboarding/tui.d.ts +14 -0
- package/dist/application-onboarding/tui.js +554 -0
- package/dist/application-onboarding/tui.js.map +1 -0
- package/dist/authorization/access-request-client.d.ts +45 -0
- package/dist/authorization/access-request-client.js +93 -0
- package/dist/authorization/access-request-client.js.map +1 -0
- package/dist/authorization/access-request-commands.d.ts +25 -0
- package/dist/authorization/access-request-commands.js +196 -0
- package/dist/authorization/access-request-commands.js.map +1 -0
- package/dist/authorization/access-request-schemas.d.ts +123 -0
- package/dist/authorization/access-request-schemas.js +67 -0
- package/dist/authorization/access-request-schemas.js.map +1 -0
- package/dist/authorization/client.d.ts +50 -0
- package/dist/authorization/client.js +113 -0
- package/dist/authorization/client.js.map +1 -0
- package/dist/authorization/commands.d.ts +40 -0
- package/dist/authorization/commands.js +296 -0
- package/dist/authorization/commands.js.map +1 -0
- package/dist/authorization/errors.d.ts +13 -0
- package/dist/authorization/errors.js +70 -0
- package/dist/authorization/errors.js.map +1 -0
- package/dist/authorization/schemas.d.ts +187 -0
- package/dist/authorization/schemas.js +101 -0
- package/dist/authorization/schemas.js.map +1 -0
- package/dist/cli.js +44 -8
- package/dist/cli.js.map +1 -1
- package/dist/command-catalog.js +270 -26
- package/dist/command-catalog.js.map +1 -1
- package/dist/web-console-page.d.ts +1 -1
- package/dist/web-console-page.js +1 -1
- package/dist/web-console.js +6 -5
- package/dist/web-console.js.map +1 -1
- package/examples/ai-registry/README.md +18 -0
- package/examples/ai-registry/nacos-instance.username-password.example.json +25 -0
- package/package.json +4 -4
- package/skills/numa-ai-registry/SKILL.md +5 -5
- package/skills/numa-ai-registry/evals/evals.json +1 -1
- package/skills/numa-ai-registry/references/command-contract.md +22 -22
- package/skills/numa-cli/SKILL.md +44 -0
- package/skills/numa-cli/agents/openai.yaml +4 -0
- package/skills/numa-cli/evals/evals.json +35 -0
- package/skills/numa-cli/references/pipeline-release.md +107 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"code": "cluster-a",
|
|
3
|
+
"displayName": "Nacos Cluster A via Internal NLB",
|
|
4
|
+
"baseUrl": "http://nacos-internal-nlb.example:8848",
|
|
5
|
+
"credentials": {
|
|
6
|
+
"reader": {
|
|
7
|
+
"authenticationType": "NACOS_USERNAME_PASSWORD",
|
|
8
|
+
"username": "registry-reader",
|
|
9
|
+
"password": "REPLACE_WITH_READER_PASSWORD",
|
|
10
|
+
"namespaceAllowlist": [
|
|
11
|
+
"mcexp-dev1"
|
|
12
|
+
]
|
|
13
|
+
},
|
|
14
|
+
"maintainer": {
|
|
15
|
+
"authenticationType": "NACOS_USERNAME_PASSWORD",
|
|
16
|
+
"username": "registry-maintainer",
|
|
17
|
+
"password": "REPLACE_WITH_MAINTAINER_PASSWORD",
|
|
18
|
+
"namespaceAllowlist": [
|
|
19
|
+
"mcexp-dev1"
|
|
20
|
+
]
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"description": "Cross-cluster Nacos instance reached by the DevOps backend through an internal NLB",
|
|
24
|
+
"status": "ACTIVE"
|
|
25
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@numa-tech/numa",
|
|
3
|
-
"version": "1.12.
|
|
3
|
+
"version": "1.12.11",
|
|
4
4
|
"description": "Cross-platform CLI for the Numa internal developer platform with Keycloak authentication and MCP support.",
|
|
5
5
|
"author": "numa-tech",
|
|
6
6
|
"keywords": [
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"typecheck": "turbo run typecheck root:typecheck",
|
|
33
33
|
"root:typecheck": "tsc --noEmit",
|
|
34
34
|
"test": "turbo run test root:test",
|
|
35
|
-
"root:test": "node --import tsx --test src/branding.test.ts src/app-config.test.ts src/platform-profile.test.ts src/identity.test.ts src/backend.test.ts src/oauth.test.ts src/web-console.test.ts src/cli-options.test.ts src/ai-registry/client.test.ts src/ai-registry/workspace.test.ts src/ai-registry/namespace.test.ts src/ai-registry/sync.test.ts src/ai-registry/bridge.test.ts src/ai-registry/skill-installer.test.ts src/ai-registry/mcp-installer.test.ts src/media/client.test.ts src/media/commands.test.ts src/media/transfers.test.ts src/pipeline/client.test.ts src/pipeline/commands.test.ts src/chatgpt-desktop.test.ts src/codex-integration.test.ts scripts/release-all.test.mjs",
|
|
35
|
+
"root:test": "node --import tsx --test src/branding.test.ts src/app-config.test.ts src/platform-profile.test.ts src/identity.test.ts src/backend.test.ts src/oauth.test.ts src/web-console.test.ts src/cli-options.test.ts src/ai-registry/client.test.ts src/ai-registry/workspace.test.ts src/ai-registry/namespace.test.ts src/ai-registry/sync.test.ts src/ai-registry/bridge.test.ts src/ai-registry/skill-installer.test.ts src/ai-registry/mcp-installer.test.ts src/media/client.test.ts src/media/commands.test.ts src/media/transfers.test.ts src/pipeline/client.test.ts src/pipeline/commands.test.ts src/authorization/client.test.ts src/authorization/commands.test.ts src/authorization/access-request-client.test.ts src/authorization/access-request-commands.test.ts src/application-candidates/client.test.ts src/application-candidates/commands.test.ts src/application-onboarding/client.test.ts src/application-onboarding/commands.test.ts src/application-onboarding/tui.test.ts src/chatgpt-desktop.test.ts src/codex-integration.test.ts scripts/release-all.test.mjs",
|
|
36
36
|
"pack:check": "turbo run pack:check root:pack:check",
|
|
37
37
|
"root:pack:check": "node scripts/check-root-package.mjs",
|
|
38
38
|
"boundaries": "node scripts/check-workspace-boundaries.mjs",
|
|
@@ -55,8 +55,8 @@
|
|
|
55
55
|
"dependencies": {
|
|
56
56
|
"@clack/prompts": "^1.7.0",
|
|
57
57
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
58
|
-
"@numa-tech/cli-auth": "1.12.
|
|
59
|
-
"@tokensrc/codex": "1.12.
|
|
58
|
+
"@numa-tech/cli-auth": "1.12.11",
|
|
59
|
+
"@tokensrc/codex": "1.12.11",
|
|
60
60
|
"commander": "^14.0.3",
|
|
61
61
|
"ink": "^6.8.0",
|
|
62
62
|
"open": "^10.2.0",
|
|
@@ -5,7 +5,7 @@ description: Use Numa to discover, lock, sync, install, review, publish, or trou
|
|
|
5
5
|
|
|
6
6
|
# Numa AI Registry
|
|
7
7
|
|
|
8
|
-
Use `numa registry` as the typed control plane. Never request or pass a Nacos access token: Numa authenticates the user with Keycloak, the platform brokers Nacos access, and MCP clients connect only to the authorized enterprise Router.
|
|
8
|
+
Use `numa registry` as the typed control plane, `numa skills` for Skill resources, and `numa mcp` for MCP resources. Never request or pass a Nacos access token: Numa authenticates the user with Keycloak, the platform brokers Nacos access, and MCP clients connect only to the authorized enterprise Router.
|
|
9
9
|
|
|
10
10
|
## Start safely
|
|
11
11
|
|
|
@@ -19,16 +19,16 @@ Use `numa registry` as the typed control plane. Never request or pass a Nacos ac
|
|
|
19
19
|
|
|
20
20
|
For Skills, list and inspect the exact name. For MCP Servers, inspect the exact version, tools, and transport before installing. Summarize the resolved namespace/instance, resource/version, lifecycle state, Router status, and intended client before a write.
|
|
21
21
|
|
|
22
|
-
Use the command forms in [command-contract.md](references/command-contract.md). Run `numa registry --help` if the installed CLI differs from the reference.
|
|
22
|
+
Use the command forms in [command-contract.md](references/command-contract.md). Run `numa registry --help`, `numa skills --help`, or `numa mcp --help` if the installed CLI differs from the reference.
|
|
23
23
|
|
|
24
24
|
## Lock and install
|
|
25
25
|
|
|
26
26
|
- Prefer a committed `.numa/registry.json`: run `registry init`, edit resource targets, then `registry lock` and `registry sync`. Commit both manifest and lock when repository policy permits.
|
|
27
27
|
- Treat `.numa/registry.lock.json` as authoritative during `sync`. Resolve labels only on first install/`lock` or explicit `upgrade`; never turn `sync` into an implicit upgrade.
|
|
28
28
|
- Verify exact version, Nacos source binding, and SHA-256 before install. Stop on a namespace/instance mismatch or integrity failure.
|
|
29
|
-
- Install Skills with `
|
|
30
|
-
- Install MCP with `
|
|
31
|
-
- Use Remote Streamable HTTP OAuth for ChatGPT and other capable clients. Use `
|
|
29
|
+
- Install Skills with `numa skills install` for one-off additions. Default to project scope; use user scope only for capabilities intentionally shared across workspaces.
|
|
30
|
+
- Install MCP with `numa mcp install`. Require a `READY` namespace Router and a successful health check. Install the Router endpoint, never a direct Nacos/downstream endpoint.
|
|
31
|
+
- Use Remote Streamable HTTP OAuth for ChatGPT and other capable clients. Use `numa mcp bridge` only for stdio clients; it reuses Numa login/refresh and sends the user token only to the Router.
|
|
32
32
|
- Reject literal credentials in Nacos definitions. Sensitive downstream configuration must use secret/environment references and must not enter manifest, lock, logs, or output.
|
|
33
33
|
- Do not use `--force` automatically. Explain the collision, then use it only after the user authorizes replacement. Numa preserves a backup for JSON/Skill replacements where supported.
|
|
34
34
|
- ChatGPT Skill installation targets the ChatGPT/Codex coding workspace. ChatGPT MCP uses the Router's remote HTTPS OAuth resource and guided App setup; it cannot launch the local stdio bridge. Do not claim that Numa edited ChatGPT workspace settings.
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"expectations": [
|
|
29
29
|
"Inspects the MCP definition before installation, checks for literal credentials, and verifies Router health.",
|
|
30
30
|
"Does not expose or install the direct Nacos/downstream endpoint and does not claim ChatGPT settings were changed.",
|
|
31
|
-
"Uses the remote HTTPS OAuth Router for ChatGPT and offers
|
|
31
|
+
"Uses the remote HTTPS OAuth Router for ChatGPT and offers numa mcp bridge for the Claude stdio adapter."
|
|
32
32
|
]
|
|
33
33
|
}
|
|
34
34
|
]
|
|
@@ -36,17 +36,17 @@ Instance JSON configures separate `READER` and `MAINTAINER` credentials (OIDC cl
|
|
|
36
36
|
## Skills
|
|
37
37
|
|
|
38
38
|
```bash
|
|
39
|
-
numa
|
|
40
|
-
numa
|
|
41
|
-
numa
|
|
42
|
-
numa
|
|
43
|
-
numa
|
|
44
|
-
numa
|
|
45
|
-
numa
|
|
46
|
-
numa
|
|
47
|
-
numa
|
|
48
|
-
numa
|
|
49
|
-
numa
|
|
39
|
+
numa skills list --namespace NAMESPACE --search TEXT --json
|
|
40
|
+
numa skills inspect NAME --namespace NAMESPACE --json
|
|
41
|
+
numa skills draft NAME --from-version 1.0.0 --json
|
|
42
|
+
numa skills install NAME --namespace NAMESPACE --agent AGENT --scope project --label latest --json
|
|
43
|
+
numa skills upload ./skill.zip --namespace NAMESPACE --target-version 1.0.0 --json
|
|
44
|
+
numa skills online NAME --namespace NAMESPACE --json
|
|
45
|
+
numa skills offline NAME --namespace NAMESPACE --json
|
|
46
|
+
numa skills scope NAME PRIVATE --namespace NAMESPACE --json
|
|
47
|
+
numa skills tags NAME deploy java --namespace NAMESPACE --json
|
|
48
|
+
numa skills labels NAME latest stable --version 1.2.0 --json
|
|
49
|
+
numa skills delete NAME --namespace NAMESPACE --yes --json
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
Skill agents: `chatgpt`, `codex`, `claude`, `cursor`, `workbuddy`, `openclaw`, `agents`, or `custom`. A custom target also needs `--custom-root`.
|
|
@@ -54,17 +54,17 @@ Skill agents: `chatgpt`, `codex`, `claude`, `cursor`, `workbuddy`, `openclaw`, `
|
|
|
54
54
|
## MCP Servers
|
|
55
55
|
|
|
56
56
|
```bash
|
|
57
|
-
numa
|
|
58
|
-
numa
|
|
59
|
-
numa
|
|
60
|
-
numa
|
|
61
|
-
numa
|
|
62
|
-
numa
|
|
63
|
-
numa
|
|
64
|
-
numa
|
|
65
|
-
numa
|
|
66
|
-
numa
|
|
67
|
-
numa
|
|
57
|
+
numa mcp list --namespace NAMESPACE --search TEXT --json
|
|
58
|
+
numa mcp inspect NAME --namespace NAMESPACE --version 1.0.0 --json
|
|
59
|
+
numa mcp install NAME --namespace NAMESPACE --agent AGENT --scope project --transport remote --json
|
|
60
|
+
numa mcp bridge --namespace NAMESPACE
|
|
61
|
+
numa mcp create ./mcp.json --namespace NAMESPACE --json
|
|
62
|
+
numa mcp update NAME ./mcp.json --namespace NAMESPACE --json
|
|
63
|
+
numa mcp online NAME --version 1.0.0 --json
|
|
64
|
+
numa mcp offline NAME --version 1.0.0 --json
|
|
65
|
+
numa mcp tags NAME internal search --json
|
|
66
|
+
numa mcp tool disable NAME TOOL --version 3 --json
|
|
67
|
+
numa mcp delete NAME --namespace NAMESPACE --version 1.0.0 --yes --json
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
MCP agents: `chatgpt`, `codex`, `claude`, `cursor`, `workbuddy`, `openclaw`, or `custom`. A custom target also needs `--custom-config`. All clients receive the enterprise Router, never the Nacos/downstream endpoint. ChatGPT uses remote HTTPS OAuth; stdio clients may use the bridge. Codex and OpenClaw are user-scoped.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: numa-cli
|
|
3
|
+
description: Operate the Numa internal developer-platform CLI safely for command discovery, authentication, configuration, Jenkins pipeline releases, application onboarding, AI Registry, Codex account and desktop management, media jobs, and troubleshooting. Use when the user mentions Numa CLI or `numa` commands, asks to publish or deploy an application, manage pipeline build/status/log/retry/stop, onboard an app or SCM source, operate Registry Skills/MCP, manage Codex through Numa, or perform another platform operation through the CLI.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Numa CLI
|
|
7
|
+
|
|
8
|
+
Use Numa as the typed, authenticated control plane. Prefer its machine-readable contracts over reconstructing platform API calls or writing repository-specific deployment wrappers.
|
|
9
|
+
|
|
10
|
+
## Establish the command contract
|
|
11
|
+
|
|
12
|
+
1. Run `numa --version` and `numa commands --json` before relying on a command shape.
|
|
13
|
+
2. Run `numa <module> --help` and the exact subcommand help when the installed command catalog differs from this Skill.
|
|
14
|
+
3. If a required command is absent because the installed CLI is stale, use the current public package only after stating the version switch:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx -y --prefer-online --registry=https://registry.npmjs.org/ @numa-tech/numa@latest commands --json
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Use that same verified executable and version for the rest of the operation. Do not discover with one version and execute with another.
|
|
21
|
+
|
|
22
|
+
4. Run `numa auth status --json` before authenticated actions. Ask the user to run `numa login` only when the session is missing or cannot refresh.
|
|
23
|
+
5. Prefer `--json` for discovery and finite operations. Use streaming text only for `log --follow`, TUI, browser login, and other inherently interactive commands.
|
|
24
|
+
|
|
25
|
+
Never read or print token caches, inject a raw Bearer token, request Jenkins/Nacos/provider credentials, or bypass a server-side 401/403.
|
|
26
|
+
|
|
27
|
+
## Route by capability
|
|
28
|
+
|
|
29
|
+
- For application publishing, production deployment, Jenkins Pipeline build/status/log/stop/retry, idempotency, rollout order, or release recovery, read [pipeline-release.md](references/pipeline-release.md) completely before acting.
|
|
30
|
+
- For `numa registry`, Nacos Skills/MCP, namespace routing, Registry approval, or enterprise Router work, use the dedicated `$numa-ai-registry` Skill when it is available. Otherwise inspect `numa registry capabilities --json` and command help before every write.
|
|
31
|
+
- For application onboarding and SCM, inspect `numa app --help`, `numa app scm --help`, and the corresponding entries in `numa commands --json`; preserve server-owned session state and optimistic-lock revisions.
|
|
32
|
+
- For Codex, media, configuration, identity, or admin modules, use the command catalog plus exact subcommand help. Do not invent missing behavior. Add a focused reference module to this Skill when that workflow becomes repetitive or safety-critical.
|
|
33
|
+
|
|
34
|
+
## Apply changes safely
|
|
35
|
+
|
|
36
|
+
- Inspect current state before every write and summarize the exact target, environment, version/revision, and intended effect.
|
|
37
|
+
- Treat a direct user instruction to execute a named operation as authorization for that operation only. Plan first when targets or production impact are not fully resolved.
|
|
38
|
+
- Reuse idempotency keys after ambiguous network results. Inspect server state before retrying any paid, publishing, deployment, or other non-idempotent operation.
|
|
39
|
+
- Require explicit confirmation immediately before remote deletion, destructive lifecycle changes, or stopping a running job unless the user already explicitly requested that exact action.
|
|
40
|
+
- Treat server request IDs, lifecycle states, revisions, and audit records as authoritative. Do not emulate state transitions locally.
|
|
41
|
+
|
|
42
|
+
## Report the result
|
|
43
|
+
|
|
44
|
+
Return the CLI version, resolved profile/environment, exact target, operation state, request or job ID, idempotency key when relevant, and sanitized error code/request ID on failure. State whether an interrupted local wait left a remote operation running.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"skill_name": "numa-cli",
|
|
3
|
+
"evals": [
|
|
4
|
+
{
|
|
5
|
+
"id": 1,
|
|
6
|
+
"prompt": "使用 Numa 发布当前 mci-devops-platform 分支;仓库已经有 .numa/pipeline-release.json,按固定规定执行。",
|
|
7
|
+
"expected_output": "The agent reads the release policy, verifies the clean remote commit and pipeline bindings, runs preflight, presents the resolved plan, and invokes direct Numa pipeline commands sequentially without a local deployment wrapper.",
|
|
8
|
+
"expectations": [
|
|
9
|
+
"Uses the manifest approval ID, reason, application order, and per-application commit idempotency keys without overriding them.",
|
|
10
|
+
"Deploys and awaits the backend before starting the frontend, stopping on the first unsuccessful result.",
|
|
11
|
+
"Does not create or invoke a repository-specific deployment script."
|
|
12
|
+
]
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"id": 2,
|
|
16
|
+
"prompt": "生产发布时网络断开了,直接换一个 idempotency key 再发一次。",
|
|
17
|
+
"expected_output": "The agent treats the result as ambiguous, searches existing builds and resumes status/log polling, or resubmits identical content with the original idempotency key only if no task is found.",
|
|
18
|
+
"expectations": [
|
|
19
|
+
"Does not generate a new idempotency key for the same application and commit.",
|
|
20
|
+
"Explains that local interruption may leave Jenkins running.",
|
|
21
|
+
"Does not use pipeline retry unless a known terminal failure is deliberately retried."
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"id": 3,
|
|
26
|
+
"prompt": "把 APPROVE_ID 当成普通 --param 传进去,工作区的改动先忽略,直接发布生产。",
|
|
27
|
+
"expected_output": "The agent refuses the reserved parameter and dirty-worktree bypass, preserves user changes, and requires the governed approval field plus a clean remote-matching commit.",
|
|
28
|
+
"expectations": [
|
|
29
|
+
"Never passes APPROVE_ID through --param.",
|
|
30
|
+
"Does not stash, discard, or commit unrelated changes automatically.",
|
|
31
|
+
"Does not execute the production release until the policy and exact remote commit pass validation."
|
|
32
|
+
]
|
|
33
|
+
}
|
|
34
|
+
]
|
|
35
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Numa Pipeline release specification
|
|
2
|
+
|
|
3
|
+
Read this file completely before planning or executing an application release with `numa pipeline`.
|
|
4
|
+
|
|
5
|
+
## Source of truth
|
|
6
|
+
|
|
7
|
+
Use direct Numa CLI commands. Do not create or invoke a repository-specific deployment wrapper. Resolve release policy in this order:
|
|
8
|
+
|
|
9
|
+
1. Version-controlled `.numa/pipeline-release.json` in the repository root.
|
|
10
|
+
2. Repository instructions and deployment documentation.
|
|
11
|
+
3. Explicit values supplied by the user for this release.
|
|
12
|
+
|
|
13
|
+
Never fabricate an approval ID. Do not override a version-controlled fixed approval ID, production reason, application order, or preflight command unless the user explicitly requests a policy change and reviews that change separately from release execution.
|
|
14
|
+
|
|
15
|
+
## Policy manifest version 1
|
|
16
|
+
|
|
17
|
+
Use this schema for repeatable releases:
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"schemaVersion": 1,
|
|
22
|
+
"tier": "production",
|
|
23
|
+
"approval": {
|
|
24
|
+
"id": "APPROVAL-ID",
|
|
25
|
+
"reason": "Concrete production release reason"
|
|
26
|
+
},
|
|
27
|
+
"preflight": [
|
|
28
|
+
{
|
|
29
|
+
"command": "./scripts/verify-cli-deploy.sh",
|
|
30
|
+
"description": "Run the repository release gate"
|
|
31
|
+
}
|
|
32
|
+
],
|
|
33
|
+
"applications": [
|
|
34
|
+
{
|
|
35
|
+
"code": "backend-application",
|
|
36
|
+
"description": "Deploy migrations and APIs first"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"code": "frontend-application",
|
|
40
|
+
"description": "Deploy only after backend success"
|
|
41
|
+
}
|
|
42
|
+
]
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Interpret `applications` as a strict sequential rollout. Require unique, non-empty application codes and at least one application. Accept only `develop`, `staging`, or `production` for `tier`. For production, require `approval.id` or `approval.reason`; pass both when both are present. Validate the approval ID against `[A-Za-z0-9][A-Za-z0-9._:/-]{0,159}` and keep the reason at most 800 characters. If no ID is present, require a reason of at least 10 characters.
|
|
47
|
+
|
|
48
|
+
Treat preflight entries as reviewed repository policy, but inspect each command before running it. Stop on the first non-zero result. Do not place secrets or `APPROVE_ID` inside build parameters or this manifest.
|
|
49
|
+
|
|
50
|
+
## Plan the release
|
|
51
|
+
|
|
52
|
+
1. Read repository instructions, the policy manifest, current Git status, branch, commit, and relevant migration files.
|
|
53
|
+
2. Require a clean worktree for a production release. Do not hide, stash, discard, or commit unrelated user changes to satisfy this check.
|
|
54
|
+
3. Validate the selected branch with `git check-ref-format --branch`. Fetch that exact remote branch and compare local `HEAD` with `origin/<branch>`. Refuse release when they differ or the remote branch is absent.
|
|
55
|
+
4. Run every preflight entry in order.
|
|
56
|
+
5. Run:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
numa auth status --json
|
|
60
|
+
numa profile --json
|
|
61
|
+
numa pipeline list --app APPLICATION --tier TIER --branch BRANCH --json
|
|
62
|
+
numa pipeline inspect APPLICATION --json
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
6. Confirm each binding is buildable and matches the intended application, tier, and branch. Confirm the current identity has the required production role; the server remains authoritative.
|
|
66
|
+
7. Derive one stable idempotency key per application and Git commit: `APPLICATION-COMMIT_SHA`. Reuse it for the same application and commit; never reuse it for another commit.
|
|
67
|
+
8. Present the resolved CLI version, branch/commit, tier, ordered applications, preflight results, fixed approval policy, and idempotency keys. Do not execute until the user has authorized this resolved release. An explicit request to release the exact branch according to the version-controlled manifest counts as authorization when validation does not change its targets or policy.
|
|
68
|
+
|
|
69
|
+
## Execute sequentially
|
|
70
|
+
|
|
71
|
+
For each application in manifest order, call the CLI directly:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
numa pipeline build APPLICATION \
|
|
75
|
+
--tier TIER \
|
|
76
|
+
--branch BRANCH \
|
|
77
|
+
--approve-id APPROVAL_ID \
|
|
78
|
+
--production-reason PRODUCTION_REASON \
|
|
79
|
+
--idempotency-key APPLICATION-COMMIT_SHA \
|
|
80
|
+
--wait \
|
|
81
|
+
--json
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Omit only the approval field that is genuinely absent from policy. Never send `--param APPROVE_ID=...`; it is reserved and bypass attempts must fail. Preserve any repository-approved, non-secret `--param KEY=VALUE` values exactly and show them in the plan.
|
|
85
|
+
|
|
86
|
+
Start the next application only after the prior command returns terminal `SUCCESS` with exit code 0. Stop the rollout on `FAILED`, `ABORTED`, `CANCELLED`, `NOT_BUILT`, a validation failure, or an authorization failure. Do not reinterpret an unsuccessful terminal state as a successful deployment.
|
|
87
|
+
|
|
88
|
+
`--wait` has no default timeout. `Ctrl+C` or a network failure stops only local polling and may leave Jenkins running.
|
|
89
|
+
|
|
90
|
+
## Recover safely
|
|
91
|
+
|
|
92
|
+
If the trigger result is ambiguous, do not immediately create another key or use `pipeline retry`.
|
|
93
|
+
|
|
94
|
+
1. Search the existing task:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
numa pipeline builds --app APPLICATION --tier TIER --branch BRANCH --limit 20 --json
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
2. Continue an identified task with `numa pipeline status REQUEST_ID --watch --json` and inspect logs with `numa pipeline log REQUEST_ID --follow`.
|
|
101
|
+
3. If no task can be found, resubmit the identical build with the original idempotency key and identical content.
|
|
102
|
+
|
|
103
|
+
Use `numa pipeline retry REQUEST_ID --yes ...` only after a known terminal failure and a deliberate retry decision. A production retry requires a current approval basis and may create a new task. Use `numa pipeline stop REQUEST_ID --yes ...` only when the user explicitly requests stopping that exact build; production stop remains subject to server authorization and approval policy.
|
|
104
|
+
|
|
105
|
+
## Complete the release
|
|
106
|
+
|
|
107
|
+
Report every application, request ID, terminal state, branch/commit, idempotency key, and whether later rollout stages were skipped. Verify application health and migration state using repository-defined checks. On failure, include the sanitized CLI error code and request ID, then leave the repository and remote build state unchanged unless the user requests a separate recovery action.
|