From 4d7b7f0b2ebfd0a2b25601806186453ef77f713f Mon Sep 17 00:00:00 2001 From: Yoni Melki Date: Tue, 25 Aug 2026 22:37:08 +0300 Subject: [PATCH 1/2] AX-2170 - Remove plugin versions from READMEs Versions live in manifests, tags, and GitHub Releases. CI now fails if READMEs reintroduce version strings. Co-authored-by: Cursor --- .github/workflows/pr.yml | 4 ++ README.md | 9 +-- scripts/validate-readme-no-version.mjs | 78 ++++++++++++++++++++++++++ 3 files changed, 85 insertions(+), 6 deletions(-) create mode 100644 scripts/validate-readme-no-version.mjs diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index dc53687..842bcd5 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -19,6 +19,10 @@ jobs: run: node --test scripts/validate.test.mjs - name: Validate manifests + skills run: node scripts/validate.mjs + - name: Validate README has no plugin version + env: + PLUGIN_MANIFEST: .codex-plugin/plugin.json + run: node scripts/validate-readme-no-version.mjs - name: Version consistency (plugin.json == package.json) run: | PJ=$(jq -r .version .codex-plugin/plugin.json) diff --git a/README.md b/README.md index 5bf79a9..86a18bb 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Before installing, make sure you have: - **JFrog host URL and access token** — Your JFrog platform URL and a valid access token. - **OpenAI Codex** — Installed, with plugin support (`codex plugin` CLI commands available). - **Node.js** (≥ 18) — with `npx` on your `PATH` (used by the Agent Guard). -- **Skill runtime requirements** — `jf` CLI, `jq`, and `curl` on `PATH`, plus a configured JFrog instance. For the minimum versions, see the upstream skills [`Requirements`](https://github.com/jfrog/jfrog-skills/blob/v0.22.0/README.md#requirements). Configure the CLI with `jf config add` — see [Authentication](#authentication). +- **Skill runtime requirements** — `jf` CLI, `jq`, and `curl` on `PATH`, plus a configured JFrog instance. For the minimum versions, see the upstream skills [`Requirements`](https://github.com/jfrog/jfrog-skills/blob/main/README.md#requirements). Configure the CLI with `jf config add` — see [Authentication](#authentication). - **JFrog AI Catalog** (optional) — If you want to use the Agent Guard feature, your JFrog subscription needs to include the AI Catalog entitlement. Contact your JFrog account team if you're unsure whether it's enabled. - **JFrog CLI ≥ 2.105.0** (optional) — If you want the Agent Guard to auto-resolve the credentials/server ID from the JFrog CLI configuration. - **JFrog project** (optional) — If you want to use the Agent Guard feature. @@ -148,7 +148,7 @@ The `skills/` tree is vendored from pinned in [`scripts/sync-skills-vendor.json`](scripts/sync-skills-vendor.json). To pull a newer upstream release into this repo: -1. Bump `pin` in `scripts/sync-skills-vendor.json` to the new tag (e.g. `v0.23.0`). +1. Bump `pin` in `scripts/sync-skills-vendor.json` to the new upstream tag. 2. Re-sync and commit the refreshed tree: ```bash @@ -160,10 +160,7 @@ To pull a newer upstream release into this repo: 3. Bump `version` in both [`.codex-plugin/plugin.json`](.codex-plugin/plugin.json) and [`package.json`](package.json) (they must match — CI enforces this) so the published plugin reflects the new skills bundle. -4. Update the pinned-version link in the [Prerequisites](#prerequisites) section so the - skill runtime requirements point at the new tag. -5. Commit the pin bump, the regenerated `skills/` tree, the version bump, and the - README link bump together, and open a PR whose merge commit subject carries a +4. Commit the pin bump, the regenerated `skills/` tree, and the version bump together, and open a PR whose merge commit subject carries a `[patch]` / `[minor]` / `[major]` marker (see [Releasing](#releasing)). See [`VENDOR.md`](VENDOR.md) for the full picture. diff --git a/scripts/validate-readme-no-version.mjs b/scripts/validate-readme-no-version.mjs new file mode 100644 index 0000000..513ce95 --- /dev/null +++ b/scripts/validate-readme-no-version.mjs @@ -0,0 +1,78 @@ +#!/usr/bin/env node + +// Copyright (c) JFrog Ltd. 2026 +// Licensed under the Apache License, Version 2.0 +// https://www.apache.org/licenses/LICENSE-2.0 + +import { readFileSync, existsSync } from "node:fs"; +import process from "node:process"; + +const docPaths = (process.env.DOCS || process.env.README_PATH || "README.md") + .split(/\s+/) + .filter(Boolean); + +const errors = []; + +for (const docPath of docPaths) { + const content = readFileSync(docPath, "utf8"); + validateDoc(docPath, content, errors); +} + +function validateDoc(docPath, content, errors) { + +const bannedPatterns = [ + { + re: /current version/i, + msg: 'README must not include a "Current version" callout — use GitHub Releases/tags.', + }, + { + re: /^## Versioning\s*$/m, + msg: 'README must not include a "## Versioning" section — versions live in the manifest and GitHub Releases.', + }, + { + re: /then tag \(for example `v/i, + msg: "README must not include example release tags.", + }, + { + re: /github\.com\/jfrog\/jfrog-skills\/blob\/v\d+\.\d+\.\d+/i, + msg: "README must not pin jfrog-skills doc links to a release tag — use main README or sync-skills-vendor.json.", + }, + { + re: /codeload\.github\.com\/jfrog\/jfrog-skills\/(tar\.gz|zip)\/v\d+\.\d+\.\d+/i, + msg: "README must not embed jfrog-skills release tags in download URLs.", + }, +]; + + for (const { re, msg } of bannedPatterns) { + if (re.test(content)) { + errors.push(`${docPath}: ${msg}`); + } + } + + const manifestPath = process.env.PLUGIN_MANIFEST; + if (docPath.endsWith("README.md") && manifestPath && existsSync(manifestPath)) { + let version; + if (manifestPath.endsWith(".json")) { + version = JSON.parse(readFileSync(manifestPath, "utf8")).version; + } else if (manifestPath.endsWith("gradle.properties")) { + const match = readFileSync(manifestPath, "utf8").match(/^version\s*=\s*(.+)$/m); + version = match?.[1]?.trim(); + } + + if (version && content.includes(version)) { + errors.push( + `${docPath}: contains plugin version "${version}" — authoritative source is ${manifestPath}.` + ); + } + } +} + +if (errors.length > 0) { + console.error("README version validation failed:"); + for (const error of errors) { + console.error(`- ${error}`); + } + process.exit(1); +} + +console.log("README version validation passed."); From 4808ab0297c12a75f1585adadbe4dcb7cc0b8b29 Mon Sep 17 00:00:00 2001 From: Yoni Melki Date: Mon, 31 Aug 2026 23:57:16 +0300 Subject: [PATCH 2/2] AX-2170 - Drop README version tests and leftover pin-sync machinery README prose checks are a maintenance trap. Vendor docs now name the authoritative pin and version sources. Co-authored-by: Cursor --- .github/workflows/pr.yml | 4 -- VENDOR.md | 3 + scripts/validate-readme-no-version.mjs | 78 -------------------------- 3 files changed, 3 insertions(+), 82 deletions(-) delete mode 100644 scripts/validate-readme-no-version.mjs diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 842bcd5..dc53687 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -19,10 +19,6 @@ jobs: run: node --test scripts/validate.test.mjs - name: Validate manifests + skills run: node scripts/validate.mjs - - name: Validate README has no plugin version - env: - PLUGIN_MANIFEST: .codex-plugin/plugin.json - run: node scripts/validate-readme-no-version.mjs - name: Version consistency (plugin.json == package.json) run: | PJ=$(jq -r .version .codex-plugin/plugin.json) diff --git a/VENDOR.md b/VENDOR.md index b2dece3..1af63b3 100644 --- a/VENDOR.md +++ b/VENDOR.md @@ -6,12 +6,15 @@ The skill packages under `skills/` are vendored from **[jfrog/jfrog-skills](http | --- | --- | | **Repository** | https://github.com/jfrog/jfrog-skills | | **Pinned release** | see `pin` in [`scripts/sync-skills-vendor.json`](scripts/sync-skills-vendor.json) | +| **Plugin version** | see `version` in [`.codex-plugin/plugin.json`](.codex-plugin/plugin.json) and [`package.json`](package.json) | Included skill directories (as of the pinned release): `jfrog/`, `jfrog-package-safety-and-download/`, `jfrog-setup-package-managers/`, `jfrog-ai-catalog-skills/`, `jfrog-mcp-management/` (JFrog Agent Guard MCP management, including the Codex harness), and `jfrog-reference-architecture/`. +The README deliberately omits release numbers. The matching manifests and GitHub tags/releases are the authoritative plugin-version sources; the vendor configuration is the authoritative skills pin. + ## Refreshing When the upstream repo publishes a new release, refresh the vendored tree via a PR that: diff --git a/scripts/validate-readme-no-version.mjs b/scripts/validate-readme-no-version.mjs deleted file mode 100644 index 513ce95..0000000 --- a/scripts/validate-readme-no-version.mjs +++ /dev/null @@ -1,78 +0,0 @@ -#!/usr/bin/env node - -// Copyright (c) JFrog Ltd. 2026 -// Licensed under the Apache License, Version 2.0 -// https://www.apache.org/licenses/LICENSE-2.0 - -import { readFileSync, existsSync } from "node:fs"; -import process from "node:process"; - -const docPaths = (process.env.DOCS || process.env.README_PATH || "README.md") - .split(/\s+/) - .filter(Boolean); - -const errors = []; - -for (const docPath of docPaths) { - const content = readFileSync(docPath, "utf8"); - validateDoc(docPath, content, errors); -} - -function validateDoc(docPath, content, errors) { - -const bannedPatterns = [ - { - re: /current version/i, - msg: 'README must not include a "Current version" callout — use GitHub Releases/tags.', - }, - { - re: /^## Versioning\s*$/m, - msg: 'README must not include a "## Versioning" section — versions live in the manifest and GitHub Releases.', - }, - { - re: /then tag \(for example `v/i, - msg: "README must not include example release tags.", - }, - { - re: /github\.com\/jfrog\/jfrog-skills\/blob\/v\d+\.\d+\.\d+/i, - msg: "README must not pin jfrog-skills doc links to a release tag — use main README or sync-skills-vendor.json.", - }, - { - re: /codeload\.github\.com\/jfrog\/jfrog-skills\/(tar\.gz|zip)\/v\d+\.\d+\.\d+/i, - msg: "README must not embed jfrog-skills release tags in download URLs.", - }, -]; - - for (const { re, msg } of bannedPatterns) { - if (re.test(content)) { - errors.push(`${docPath}: ${msg}`); - } - } - - const manifestPath = process.env.PLUGIN_MANIFEST; - if (docPath.endsWith("README.md") && manifestPath && existsSync(manifestPath)) { - let version; - if (manifestPath.endsWith(".json")) { - version = JSON.parse(readFileSync(manifestPath, "utf8")).version; - } else if (manifestPath.endsWith("gradle.properties")) { - const match = readFileSync(manifestPath, "utf8").match(/^version\s*=\s*(.+)$/m); - version = match?.[1]?.trim(); - } - - if (version && content.includes(version)) { - errors.push( - `${docPath}: contains plugin version "${version}" — authoritative source is ${manifestPath}.` - ); - } - } -} - -if (errors.length > 0) { - console.error("README version validation failed:"); - for (const error of errors) { - console.error(`- ${error}`); - } - process.exit(1); -} - -console.log("README version validation passed.");