Compare commits

...
Author SHA1 Message Date
james.maesandClaude Fable 5.1 b3a64716db docs: changelog for core publishing, the shared dist-tag and the platform lanes
The CHANGELOG's Unreleased section did not mention what this branch
adds to the cli profile; the entry mirrors the PR description so the
next release notes can be cut from the file.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-11-01 04:09:48 -06:00
james.maesandClaude Fable 5.1 4119818f1b fix: publish final CLI releases under the latest dist-tag
cli_publish always used --tag rc, so a final 1.0.0 would never become
latest and a plain npm install would keep resolving the last rc. Derive
one dist-tag for all four packages: rc if any of their versions has a
prerelease part, otherwise latest. Requiring all four to be final keeps
latest from ever pointing at a prerelease client or conformance build.

Proposal: qqq-cli docs/ci-lanes.md, item 1b.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-31 19:27:22 -05:00
james.maesandClaude Fable 5.1 63acb85f9a fix: name and import the CLI platform lane's Node setup
orb-tools/review rejected cli_platform with RC008 (an unnamed run step)
and RC009 (a multi-line inline command). Move the nvm setup and version
print into an included script, passing the version as PARAM_NODE_VERSION
like the other included scripts, so every step is named and imported.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-31 19:14:33 -05:00
james.maesandClaude Fable 5.1 e3cbb51c3c feat: publish qqq-core and add opt-in CLI platform lanes
The CLI now pins @qrun-io/qqq-core exactly, but the cli profile published
only the client, conformance and CLI, so a tagged CLI could not be
installed. Publish core between the client and conformance, and refuse to
publish unless core shares the CLI version and matches the CLI's exact
core dependency (the tag stays bound to the client version).

The CLI ships macOS/Windows binaries and three keyring backends, yet only
Linux ran anything. A new optional manifest key, platforms: [macos-arm64,
windows-x64], adds a cli_platform job per entry (npm ci, build, test,
lint on Node 20) that must pass before a tag publishes. Repositories
without the key render exactly the same pipeline as before.

cli_verify now also runs npm run lint (it checks release versions agree)
and diffs the generated core operations.ts, and the image moves from
cimg/node:22.12 to 22.23, checked against qqq-cli's release branch.

Proposal: qqq-cli docs/ci-lanes.md (Option A).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-31 19:12:51 -05:00
14 changed files with 198 additions and 30 deletions

No files matched your search

+6
View File
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Added
- `cli` profile: publishes `@qrun-io/qqq-core` between the client and the conformance package on tag publishes, and refuses to publish when core's version differs from the CLI's or from the CLI's exact core dependency
- `cli` profile: one shared npm dist-tag for the four packages, `latest` when every version is final and `rc` when any has a prerelease part
- `cli` profile: optional `platforms: [macos-arm64, windows-x64]` manifest key that adds `cli_platform` lanes (new `cli_macos_arm64` and `cli_windows_x64` executors); a publishing tag's `cli_verify_publish` requires them. Off by default; other profiles reject the key
- `cli_verify.sh` runs `npm run lint` and diffs `packages/core/src/api/operations.ts` in the drift check; Node image `cimg/node:22.23`
### Fixed
- Maven compile, verify and frontend test steps pass `--update-snapshots`, so SNAPSHOT dependencies restored from the pom-checksum-keyed `~/.m2` cache are re-checked against the remote on every build instead of going stale
+15 -5
View File
@@ -170,16 +170,26 @@ rather than silently ignored on these profiles. Existing direct jobs remain usab
## CLI profile
`cli` owns npm install, generated-client drift, build, unit tests and the real
Prism smoke contract through `cli_verify_publish`. Publication is **disabled by
`cli` owns npm install, generated-client and operations drift, build, unit tests,
lint and the real Prism smoke contract through `cli_verify_publish`. Publication is **disabled by
default**. To enable the existing v-tag publication, declare `publish.release:
true` plus `publish_context: VERIFIED_CONTEXT_NAME`, after verifying that an
existing trusted CircleCI context grants the required GitHub Packages permission.
No context name or credential availability is inferred from the former Actions
GITHUB_TOKEN. A tag must resolve to the current checkout; the job additionally
checks the client version before publishing its three fixed workspaces with the
existing rc dist-tag. Main pushes never publish. CLI docs-only is currently
rejected because generated-client verification remains mandatory.
checks the client version, and that core shares the CLI version and matches the
CLI's exact core dependency, before publishing its four fixed workspaces (client,
core, conformance, CLI) under one dist-tag: `rc` if any of the four versions has
a prerelease part, otherwise `latest`. Main pushes never publish.
CLI docs-only is currently rejected because generated-client verification remains
mandatory.
Optional platform lanes are **off by default**. `platforms: [macos-arm64,
windows-x64]` (either or both) adds one `cli_platform` job per entry (`npm ci`,
build, tests and lint on Node 20 via the image's nvm), named `cli-macos-arm64` /
`cli-windows-x64`. On a publishing tag `cli_verify_publish` requires them. The
lanes use the `m4pro.medium` macOS and `windows.medium` resource classes, which
the CircleCI plan must include.
## Conservative documentation routing
+6
View File
@@ -0,0 +1,6 @@
description: >
macOS arm64 executor for the opt-in CLI platform lane.
Requires the CircleCI plan to include the m4pro.medium resource class.
macos:
xcode: 16.4.0
resource_class: m4pro.medium
+7
View File
@@ -0,0 +1,7 @@
description: >
Windows x64 executor for the opt-in CLI platform lane. Steps run in Git Bash.
Requires the CircleCI plan to include the windows.medium resource class.
machine:
image: windows-server-2022-gui:current
resource_class: windows.medium
shell: bash.exe
+25
View File
@@ -0,0 +1,25 @@
description: >
Opt-in CLI platform lane: install, build, unit tests and lint on a non-Linux
executor. Rendered by the cli profile only for manifest platforms entries.
executor: << parameters.executor >>
parameters:
executor:
type: executor
description: "qqq-orb/cli_macos_arm64 or qqq-orb/cli_windows_x64"
node_version:
type: string
default: "20.20.2"
description: "Exact Node.js version installed with the image's nvm (the packages' engines floor)"
steps:
- checkout
- run:
name: Install Node.js << parameters.node_version >>
environment:
PARAM_NODE_VERSION: << parameters.node_version >>
command: <<include(scripts/cli_platform_node.sh)>>
- run:
name: Install locked CLI dependencies
command: npm ci
- run:
name: Build, tests and lint
command: npm run build && npm test && npm run lint
+3 -3
View File
@@ -1,13 +1,13 @@
description: >
Authoritative QQQ CLI validation, with optional tagged GitHub Packages publication.
Preserves generated-schema drift, build, tests and Prism smoke before publishing.
Preserves generated-schema drift, build, tests, lint and Prism smoke before publishing.
docker:
- image: cimg/node:22.12
- image: cimg/node:22.23
parameters:
publish:
type: boolean
default: false
description: "Publish three workspaces with rc dist-tag; requires matching version tag and GITHUB_TOKEN"
description: "Publish four workspaces (dist-tag rc for prereleases, latest for final versions); requires matching version tag and GITHUB_TOKEN"
steps:
- checkout
- restore_cache:
+15
View File
@@ -0,0 +1,15 @@
#!/bin/bash
# nvm is a shell function on macOS and not nounset-safe, so no -u here.
set -eo pipefail
# Install the exact Node.js version with the image's nvm (macOS login shell, nvm-windows in Git Bash).
nvm install "$PARAM_NODE_VERSION"
if [[ "$OSTYPE" == darwin* ]]; then
# Later steps start new login shells: make the version their default.
nvm alias default "$PARAM_NODE_VERSION"
else
# nvm-windows switches the global symlink, which later steps inherit.
nvm use "$PARAM_NODE_VERSION"
fi
node --version
npm --version
+18 -4
View File
@@ -2,10 +2,12 @@
set -euo pipefail
# Validate tag and fixed package destinations before asking for credentials.
node --input-type=commonjs - <<'NODE'
# Prints the npm dist-tag shared by all four packages.
dist_tag=$(node --input-type=commonjs - <<'NODE'
const fs = require('node:fs');
const packages = [
['packages/ui-api-client/package.json', '@qrun-io/qqq-ui-api-client'],
['packages/core/package.json', '@qrun-io/qqq-core'],
['packages/conformance/package.json', '@qrun-io/qqq-ui-api-conformance'],
['packages/cli/package.json', '@qrun-io/qqq-cli'],
];
@@ -19,7 +21,18 @@ const client = JSON.parse(fs.readFileSync(packages[0][0], 'utf8'));
if (!process.env.CIRCLE_TAG || process.env.CIRCLE_TAG !== 'v' + client.version) {
throw new Error('Version tag must match the client package version');
}
// The CLI pins core exactly and shares its version: publish only that pair.
const core = JSON.parse(fs.readFileSync(packages[1][0], 'utf8'));
const cli = JSON.parse(fs.readFileSync(packages[3][0], 'utf8'));
if (core.version !== cli.version || cli.dependencies?.['@qrun-io/qqq-core'] !== core.version) {
throw new Error('Core package version must match the CLI version and its exact core dependency');
}
// Final releases become latest; any prerelease part (e.g. -rc.1, -beta.2) in
// any of the four keeps every package on rc, so latest never points at an rc.
const versions = packages.map(([path]) => JSON.parse(fs.readFileSync(path, 'utf8')).version);
console.log(versions.some((version) => version.includes('-')) ? 'rc' : 'latest');
NODE
)
: "${GITHUB_TOKEN:?GitHub Packages write credential GITHUB_TOKEN is required}"
export NODE_AUTH_TOKEN="$GITHUB_TOKEN"
# Store only an environment substitution, never the token itself.
@@ -35,6 +48,7 @@ export NPM_CONFIG_USERCONFIG="$npm_config"
# Authentication alone is not proof of package write permission; hosted publish
# migration remains gated on verifying the actual context's package access.
npm whoami --registry https://npm.pkg.github.com >/dev/null
npm publish -w @qrun-io/qqq-ui-api-client --registry https://npm.pkg.github.com --tag rc
npm publish -w @qrun-io/qqq-ui-api-conformance --registry https://npm.pkg.github.com --tag rc
npm publish -w @qrun-io/qqq-cli --registry https://npm.pkg.github.com --tag rc
npm publish -w @qrun-io/qqq-ui-api-client --registry https://npm.pkg.github.com --tag "$dist_tag"
npm publish -w @qrun-io/qqq-core --registry https://npm.pkg.github.com --tag "$dist_tag"
npm publish -w @qrun-io/qqq-ui-api-conformance --registry https://npm.pkg.github.com --tag "$dist_tag"
npm publish -w @qrun-io/qqq-cli --registry https://npm.pkg.github.com --tag "$dist_tag"
+2 -1
View File
@@ -2,9 +2,10 @@
set -euo pipefail
npm run generate
git diff --exit-code -- packages/ui-api-client/src/schema.ts
git diff --exit-code -- packages/ui-api-client/src/schema.ts packages/core/src/api/operations.ts
npm run build
npm test
npm run lint
# Use the locked local executable; never download an unpinned npx fallback.
./node_modules/.bin/prism mock --port 4010 packages/ui-api-client/openapi/qqq-v1.json > prism.log 2>&1 &
+17 -3
View File
@@ -64,6 +64,10 @@ def boolean(data, key, default):
return value
# Opt-in CLI platform lanes: manifest entry -> orb executor.
CLI_PLATFORMS = {"macos-arm64": "qqq-orb/cli_macos_arm64", "windows-x64": "qqq-orb/cli_windows_x64"}
def load_manifest(path, setup_version):
raw = Path(path).read_text(encoding="utf-8")
if len(raw) > 65536:
@@ -84,7 +88,7 @@ def load_manifest(path, setup_version):
if profile == "qbit":
allowed += ("release_completion", "release_on_main", "release_tag_policy", "test_branch_policy")
elif profile == "cli":
allowed += ("publish_context",)
allowed += ("publish_context", "platforms")
elif profile in ("voyage", "frontend-next", "app-starter", "android", "mcp-policy", "repository-policy", "marketing", "application-template"):
allowed = ("profile", "orb_version", "default_branch")
elif profile == "all":
@@ -159,6 +163,9 @@ def load_manifest(path, setup_version):
raise ManifestError("CLI publication requires an explicitly verified context")
if profile == "cli" and boolean(data, "docs_only", False):
raise ManifestError("CLI currently requires full generated-client verification")
platforms = data.get("platforms", [])
if not isinstance(platforms, list) or any(not isinstance(x, str) or x not in CLI_PLATFORMS for x in platforms) or len(platforms) != len(set(platforms)):
raise ManifestError("platforms must be distinct entries of " + ", ".join(CLI_PLATFORMS))
tag_policy = data.get("release_tag_policy", "stable")
if tag_policy not in ("stable", "v-prefix", "none"):
raise ManifestError("Unsupported QBit release tag policy")
@@ -174,7 +181,7 @@ def load_manifest(path, setup_version):
"release_on_main": boolean(data, "release_on_main", False),
"release_tag_policy": tag_policy, "test_branch_policy": test_policy,
"docs_only": boolean(data, "docs_only", False),
"publish_context": publish_context,
"publish_context": publish_context, "platforms": platforms,
"publish": {key: boolean(publishing, key, key != "asciidoc" and profile not in ("cli", "all", "repository-policy", "application-template")
and not (profile == "qbit" and key in ("hotfix", "feature")))
for key in publish_keys}}
@@ -436,9 +443,16 @@ def cli_template(config, branch, tag):
options = {"publish": publish, "filters": filters}
if publish:
options["context"] = [config["publish_context"]]
platforms = config.get("platforms", [])
jobs = [{"qqq-orb/cli_platform": {"name": "cli-" + p, "executor": CLI_PLATFORMS[p], "filters": copy.deepcopy(filters)}}
for p in platforms]
if publish and platforms:
# Every opted-in platform must pass before packages are published.
options["requires"] = ["cli-" + p for p in platforms]
jobs.append({"qqq-orb/cli_verify_publish": options})
# CLI docs are still verified until its generated-client inputs get a dedicated policy.
return {"version": 2.1, "orbs": {"qqq-orb": "kingsrook/qqq-orb@" + config["orb_version"]},
"workflows": {"publish_release" if publish else "test_only": {"jobs": [{"qqq-orb/cli_verify_publish": options}]}}}
"workflows": {"publish_release" if publish else "test_only": {"jobs": jobs}}}
def marketing_template(config, branch, tag):
+17 -3
View File
@@ -64,6 +64,10 @@ def boolean(data, key, default):
return value
# Opt-in CLI platform lanes: manifest entry -> orb executor.
CLI_PLATFORMS = {"macos-arm64": "qqq-orb/cli_macos_arm64", "windows-x64": "qqq-orb/cli_windows_x64"}
def load_manifest(path, setup_version):
raw = Path(path).read_text(encoding="utf-8")
if len(raw) > 65536:
@@ -84,7 +88,7 @@ def load_manifest(path, setup_version):
if profile == "qbit":
allowed += ("release_completion", "release_on_main", "release_tag_policy", "test_branch_policy")
elif profile == "cli":
allowed += ("publish_context",)
allowed += ("publish_context", "platforms")
elif profile in ("voyage", "frontend-next", "app-starter", "android", "mcp-policy", "repository-policy", "marketing", "application-template"):
allowed = ("profile", "orb_version", "default_branch")
elif profile == "all":
@@ -159,6 +163,9 @@ def load_manifest(path, setup_version):
raise ManifestError("CLI publication requires an explicitly verified context")
if profile == "cli" and boolean(data, "docs_only", False):
raise ManifestError("CLI currently requires full generated-client verification")
platforms = data.get("platforms", [])
if not isinstance(platforms, list) or any(not isinstance(x, str) or x not in CLI_PLATFORMS for x in platforms) or len(platforms) != len(set(platforms)):
raise ManifestError("platforms must be distinct entries of " + ", ".join(CLI_PLATFORMS))
tag_policy = data.get("release_tag_policy", "stable")
if tag_policy not in ("stable", "v-prefix", "none"):
raise ManifestError("Unsupported QBit release tag policy")
@@ -174,7 +181,7 @@ def load_manifest(path, setup_version):
"release_on_main": boolean(data, "release_on_main", False),
"release_tag_policy": tag_policy, "test_branch_policy": test_policy,
"docs_only": boolean(data, "docs_only", False),
"publish_context": publish_context,
"publish_context": publish_context, "platforms": platforms,
"publish": {key: boolean(publishing, key, key != "asciidoc" and profile not in ("cli", "all", "repository-policy", "application-template")
and not (profile == "qbit" and key in ("hotfix", "feature")))
for key in publish_keys}}
@@ -436,9 +443,16 @@ def cli_template(config, branch, tag):
options = {"publish": publish, "filters": filters}
if publish:
options["context"] = [config["publish_context"]]
platforms = config.get("platforms", [])
jobs = [{"qqq-orb/cli_platform": {"name": "cli-" + p, "executor": CLI_PLATFORMS[p], "filters": copy.deepcopy(filters)}}
for p in platforms]
if publish and platforms:
# Every opted-in platform must pass before packages are published.
options["requires"] = ["cli-" + p for p in platforms]
jobs.append({"qqq-orb/cli_verify_publish": options})
# CLI docs are still verified until its generated-client inputs get a dedicated policy.
return {"version": 2.1, "orbs": {"qqq-orb": "kingsrook/qqq-orb@" + config["orb_version"]},
"workflows": {"publish_release" if publish else "test_only": {"jobs": [{"qqq-orb/cli_verify_publish": options}]}}}
"workflows": {"publish_release" if publish else "test_only": {"jobs": jobs}}}
def marketing_template(config, branch, tag):
+27 -10
View File
@@ -5,7 +5,7 @@ scripts=$(cd "$(dirname "${BASH_SOURCE[0]}")/../src/scripts" && pwd)
scratch=$(mktemp -d)
trap 'rm -rf "$scratch"' EXIT
cd "$scratch"
mkdir -p bin node_modules/.bin packages/{ui-api-client,conformance,cli}/src
mkdir -p bin node_modules/.bin packages/{ui-api-client,core,conformance,cli}/src
export CLI_LOG="$scratch/commands" PRISM_PID_FILE="$scratch/prism-pid" CONFIG_PATH_FILE="$scratch/npm-config-path"
cat > bin/npm <<'STUB'
#!/bin/bash
@@ -35,7 +35,7 @@ chmod +x bin/* node_modules/.bin/prism
export PATH="$scratch/bin:$PATH"
: > "$CLI_LOG"
bash "$scripts/cli_verify.sh"
[[ "$(cat "$CLI_LOG")" == $'run generate\nrun build\ntest' ]]
[[ "$(cat "$CLI_LOG")" == $'run generate\nrun build\ntest\nrun lint' ]]
if [[ -e "$PRISM_PID_FILE" ]] && kill -0 "$(cat "$PRISM_PID_FILE")" 2>/dev/null; then
echo 'Prism process survived cleanup' >&2
exit 1
@@ -51,20 +51,37 @@ if [[ -e "$PRISM_PID_FILE" ]] && kill -0 "$(cat "$PRISM_PID_FILE")" 2>/dev/null;
echo 'Prism process survived cleanup' >&2
exit 1
fi
for item in 'ui-api-client qqq-ui-api-client 1.6.0-rc.1' 'conformance qqq-ui-api-conformance 1.6.0-rc.1' 'cli qqq-cli 0.1.0-rc.1'; do
read -r dir name version <<< "$item"
printf '{"name":"@qrun-io/%s","version":"%s","publishConfig":{"registry":"https://npm.pkg.github.com"}}\n' "$name" "$version" > "packages/$dir/package.json"
done
write_packages() {
local core_version=$1 core_dependency=$2 client_version=${3:-1.6.0-rc.1} cli_version=${4:-0.1.0-rc.1} item dir name version
for item in "ui-api-client qqq-ui-api-client $client_version" "core qqq-core $core_version" "conformance qqq-ui-api-conformance $client_version" "cli qqq-cli $cli_version"; do
read -r dir name version <<< "$item"
printf '{"name":"@qrun-io/%s","version":"%s","publishConfig":{"registry":"https://npm.pkg.github.com"},"dependencies":{"@qrun-io/qqq-core":"%s"}}\n' "$name" "$version" "$core_dependency" > "packages/$dir/package.json"
done
}
write_packages 0.1.0-rc.1 0.1.0-rc.1
export CIRCLE_TAG=v1.6.0-rc.1 GITHUB_TOKEN=test-not-a-credential
: > "$CLI_LOG"
bash "$scripts/cli_publish.sh"
[[ $(grep -c '^publish ' "$CLI_LOG") -eq 3 ]]
[[ $(grep -c -- '--tag rc$' "$CLI_LOG") -eq 3 ]]
[[ "$(grep '^publish ' "$CLI_LOG" | cut -d' ' -f3)" == $'@qrun-io/qqq-ui-api-client\n@qrun-io/qqq-core\n@qrun-io/qqq-ui-api-conformance\n@qrun-io/qqq-cli' ]]
[[ $(grep -c -- '--tag rc$' "$CLI_LOG") -eq 4 ]]
# Final versions publish as latest; any prerelease among the four keeps rc.
write_packages 1.0.0 1.0.0 1.6.0 1.0.0
: > "$CLI_LOG"
CIRCLE_TAG=v1.6.0 bash "$scripts/cli_publish.sh"
[[ $(grep -c -- '--tag latest$' "$CLI_LOG") -eq 4 ]]
[[ $(grep -c '^publish ' "$CLI_LOG") -eq 4 ]]
write_packages 1.0.0 1.0.0 1.6.0-rc.3 1.0.0
: > "$CLI_LOG"
CIRCLE_TAG=v1.6.0-rc.3 bash "$scripts/cli_publish.sh"
[[ $(grep -c -- '--tag rc$' "$CLI_LOG") -eq 4 ]]
[[ $(grep -c '^test$' "$CLI_LOG" || true) -eq 0 ]]
[[ ! -e "$(cat "$CONFIG_PATH_FILE")" ]]
for condition in wrong-tag missing-token denied-auth; do
for condition in wrong-tag missing-token denied-auth core-version core-dependency; do
: > "$CLI_LOG"
write_packages 0.1.0-rc.1 0.1.0-rc.1
case "$condition" in
core-version) write_packages 0.1.0-rc.2 0.1.0-rc.2; if bash "$scripts/cli_publish.sh" >/dev/null 2>&1; then exit 1; fi ;;
core-dependency) write_packages 0.1.0-rc.1 0.1.0-rc.0; if bash "$scripts/cli_publish.sh" >/dev/null 2>&1; then exit 1; fi ;;
wrong-tag) if CIRCLE_TAG=v0.1.0 bash "$scripts/cli_publish.sh" >/dev/null 2>&1; then exit 1; fi ;;
missing-token) if GITHUB_TOKEN='' bash "$scripts/cli_publish.sh" >/dev/null 2>&1; then exit 1; fi ;;
denied-auth) if FAIL_AUTH=true bash "$scripts/cli_publish.sh" >/dev/null 2>&1; then exit 1; fi ;;
@@ -74,4 +91,4 @@ for condition in wrong-tag missing-token denied-auth; do
exit 1
fi
done
printf 'PASS: CLI validation once, drift/test/smoke failures, cleanup, tag/auth checks and three rc publishes (stubbed)\n'
printf 'PASS: CLI validation once, drift/test/smoke failures, cleanup, tag/core-version/auth checks and four rc/latest publishes (stubbed)\n'
+13 -1
View File
@@ -10,7 +10,7 @@ class CliContract(unittest.TestCase):
def test_single_full_validation_and_opt_in_publication(self):
config = yaml.safe_load((ROOT / "src/jobs/cli_verify_publish.yml").read_text())
self.assertIs(config["parameters"]["publish"]["default"], False)
self.assertEqual(config["docker"], [{"image": "cimg/node:22.12"}])
self.assertEqual(config["docker"], [{"image": "cimg/node:22.23"}])
steps = config["steps"]
ci = [i for i, s in enumerate(steps) if isinstance(s, dict) and s.get("run", {}).get("command") == "npm ci"]
verify = [i for i, s in enumerate(steps) if "scripts/cli_verify.sh" in str(s)]
@@ -24,6 +24,18 @@ class CliContract(unittest.TestCase):
cache = next(s["save_cache"] for s in steps if isinstance(s, dict) and "save_cache" in s)
self.assertEqual(cache["paths"], ["~/.npm"])
def test_platform_lane_runs_install_build_test_and_lint(self):
config = yaml.safe_load((ROOT / "src/jobs/cli_platform.yml").read_text())
self.assertEqual(config["executor"], "<< parameters.executor >>")
self.assertEqual(config["parameters"]["executor"]["type"], "executor")
commands = [s["run"]["command"] if isinstance(s["run"], dict) else s["run"]
for s in config["steps"] if isinstance(s, dict) and "run" in s]
self.assertIn("npm ci", commands)
self.assertEqual(commands[-1], "npm run build && npm test && npm run lint")
self.assertNotIn("publish", str(config))
for name in ("cli_macos_arm64", "cli_windows_x64"):
self.assertTrue((ROOT / "src/executors" / (name + ".yml")).exists())
if __name__ == "__main__":
unittest.main()
+27
View File
@@ -766,6 +766,33 @@ class PipelineTests(unittest.TestCase):
if PACKED:
self.assertEqual(self.render(), self.render(packed=True))
def test_cli_platform_lanes_are_opt_in_and_gate_publication(self):
self.write_manifest(profile="cli", default_branch="main")
jobs = self.render(CIRCLE_BRANCH="main")["workflows"]["test_only"]["jobs"]
self.assertEqual([next(iter(job)) for job in jobs], ["qqq-orb/cli_verify_publish"])
for invalid in (["linux-x64"], ["macos-arm64", "macos-arm64"], "macos-arm64", [{"macos-arm64": True}]):
self.write_manifest(profile="cli", default_branch="main", platforms=invalid)
self.render(ok=False)
self.write_manifest(profile="qbit", platforms=["macos-arm64"])
self.render(ok=False)
self.write_manifest(profile="cli", default_branch="main", platforms=["macos-arm64", "windows-x64"])
jobs = self.render(CIRCLE_BRANCH="main")["workflows"]["test_only"]["jobs"]
lanes = [job["qqq-orb/cli_platform"] for job in jobs[:2]]
self.assertEqual([(lane["name"], lane["executor"]) for lane in lanes],
[("cli-macos-arm64", "qqq-orb/cli_macos_arm64"), ("cli-windows-x64", "qqq-orb/cli_windows_x64")])
verify = jobs[2]["qqq-orb/cli_verify_publish"]
self.assertNotIn("requires", verify)
self.assertTrue(all(lane["filters"] == verify["filters"] for lane in lanes))
self.write_manifest(profile="cli", default_branch="main", platforms=["windows-x64"],
publish={"release": True}, publish_context="verified-packages")
self.git("tag", "v1.0.0-RC.2")
jobs = self.render(CIRCLE_TAG="v1.0.0-RC.2")["workflows"]["publish_release"]["jobs"]
self.assertEqual(jobs[0]["qqq-orb/cli_platform"]["name"], "cli-windows-x64")
self.assertNotIn("context", jobs[0]["qqq-orb/cli_platform"])
self.assertEqual(jobs[1]["qqq-orb/cli_verify_publish"]["requires"], ["cli-windows-x64"])
if PACKED:
self.assertEqual(self.render(CIRCLE_TAG="v1.0.0-RC.2"), self.render(packed=True, CIRCLE_TAG="v1.0.0-RC.2"))
def test_voyage_selected_workflow_retains_all_filters_and_actions(self):
self.write_manifest(profile="voyage")
template = json.loads(json.dumps(pipeline.VOYAGE_TEMPLATE).replace("__ORB_VERSION__", "0.7.0"))