Skip to content

docs: comprehensive README audit, package.json standardization, and source fixes - #2632

Merged
cs-raj merged 2 commits into
v2-devfrom
fix/DX-9364
Jul 7, 2026
Merged

docs: comprehensive README audit, package.json standardization, and source fixes#2632
cs-raj merged 2 commits into
v2-devfrom
fix/DX-9364

Conversation

@cs-raj

Copy link
Copy Markdown
Contributor

Summary

Full audit of all READMEs, package.json metadata, and source files in the cli monorepo. Code and manifests were used as the source of truth throughout.


Root README.md

  • Updated Node.js prerequisite from v16 → v22
  • Fixed cm namespace link: bulk-publishbulk-operations (package was renamed)
  • Fixed broken link syntax for export-to-csv and seed (erroneous space before ()
  • Updated stale docs URL: /docs/developers/cli/docs/headless-cms/cli
  • Fixed tsgen Useful Plugins link from archived Contentstack-Solutions fork → cli-plugins monorepo

package.json — all 5 packages

Standardized repository field from bare strings / empty values to npm-recommended monorepo format:

{
"type": "git",
"url": "git+https://github.com/contentstack/cli.git",
"directory": "packages/<pkg>"
}
PackageIssue
contentstack-utilitiesurl was an empty string
contentstack-authbare string "contentstack/cli"
contentstack-commandbare string "contentstack/cli"
contentstack-configbare string "contentstack/cli"
contentstackbare string "https://github.com/contentstack/cli" (no directory)

contentstack-auth

README:

  • Added missing auth:tokens:list command section (full FLAGS, DESCRIPTION, EXAMPLES, _See code_)
  • Removed phantom csdx tokens alias section generated by oclif (corrupt USAGE line)
  • Removed non-existent -i, --ignore flag from auth:tokens:remove
  • Updated auth:tokens description and examples to reflect list as a subcommand

Source — auth/whoami.ts:

  • Fixed typo: "Display current users email address""Display current user's email address"

contentstack-config

Source — config/set/early-access-header.ts + README:

  • Fixed swapped flag descriptions: --header was describing the alias; --header-alias was describing the value — both corrected in source and README
  • Renamed --asset-management--cs-assets in config:set:region (matches renamed flag in code)
  • Removed short -n flag from --name in config:set:region
  • Fixed stale docs URL in package intro text

contentstack (aggregate CLI README)

This is the largest change — the aggregate README documents all 17 bundled plugins.

Broken _See code_ links fixed — 13 total

Command(s)OldFixed
bootstrap, clone, export, import, import-setup, migration, seedcli/blob/main/packages/...cli-plugins/blob/main/packages/...
cm:branches (×6)cli/blob/main/packages/contentstack-export/...cli-plugins/blob/main/packages/contentstack-branches/...
cm:stacks:migration.js extension + wrong repo.ts + cli-plugins
cm:stacks:audit, audit:fixcontentstack/audit/blob/main/...cli-plugins/blob/main/packages/contentstack-audit/...

Missing command sections added

  • auth:tokens:list — sourced from auth manifest
  • cm:branches:merge-status — was lost in a merge conflict
  • launch:rollback — new command, not yet documented

New flags documented

  • launch --response-mode=<buffered|streaming>
  • cm:stacks:import --skip-taxonomy-publish

Stale / wrong content removed

  • All legacy cm:bulk-publish, cm:stacks:publish, cm:stacks:publish-revert sections (package removed)
  • Phantom csdx tokens alias section
  • All merge conflict markers (<<<<<<<, =======, >>>>>>>) from TOC and body

Flag corrections

CommandFix
cm:stacks:import-setup--modules--module in TOC, heading, USAGE, and EXAMPLE
cm:stacks:export--module updated from =<value> to =<option> with full enum list
cm:stacks:importsame as export; added --skip-taxonomy-publish
cm:stacks:seedUSAGE + FLAGS corrected to match manifest (--yes is boolean; -o/-r/-s short flags removed)
config:set:region--asset-management--cs-assets; removed -n short flag

Other

  • @oclif/plugin-help and @oclif/plugin-plugins_See code_ version numbers bumped
  • All usage-block version strings updated (node v22.13.1 → v22.21.1, package versions)

@github-actions

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check TypeCount (with fixes)Without fixesThresholdResult
🔴 Critical Severity0010✅ Passed
🟠 High Severity0025✅ Passed
🟡 Medium Severity02500✅ Passed
🔵 Low Severity001000✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

SeverityBreaches (with fixes)Breaches (no fixes)SLA Threshold (with/no fixes)Status
🔴 Critical0015 / 30 days✅ Passed
🟠 High0030 / 120 days✅ Passed
🟡 Medium0090 / 365 days✅ Passed
🔵 Low00180 / 365 days✅ Passed

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 0
  • Medium without fixes: 2
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

@github-actions

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check TypeCount (with fixes)Without fixesThresholdResult
🔴 Critical Severity0010✅ Passed
🟠 High Severity0025✅ Passed
🟡 Medium Severity02500✅ Passed
🔵 Low Severity001000✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

SeverityBreaches (with fixes)Breaches (no fixes)SLA Threshold (with/no fixes)Status
🔴 Critical0015 / 30 days✅ Passed
🟠 High0030 / 120 days✅ Passed
🟡 Medium0090 / 365 days✅ Passed
🔵 Low00180 / 365 days✅ Passed

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 0
  • Medium without fixes: 2
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

@cs-raj
cs-raj merged commit d96870a into v2-devJul 7, 2026
10 checks passed
@cs-raj
cs-raj deleted the fix/DX-9364 branch July 7, 2026 09:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@cs-raj@harshitha-cstk