Skip to content

docs(libraries): use positional policy argument for enable/disable/update#3599

Open
s-stumbo wants to merge 2 commits into
mainfrom
policy-name-updates
Open

docs(libraries): use positional policy argument for enable/disable/update#3599
s-stumbo wants to merge 2 commits into
mainfrom
policy-name-updates

Conversation

@s-stumbo

Copy link
Copy Markdown
Collaborator

What

Updates the Chainguard Libraries docs to reflect chainguard-dev/mono#46764, which makes chainctl libraries policy enable and disable accept the policy name or ID as a positional argument (matching describe/update/delete).

The docs previously used --name on enable and update — neither command has ever accepted --name — and used --policy on enable. All such references now use the positional form. create --name is left unchanged, since create still requires --name to name a new policy.

Changes

  • content/chainguard/libraries/access.md — 5 enable --policy= → positional; 4 enable --name= → positional; 2 update --name= → positional.
  • content/chainguard/libraries/java/migration.md — 1 enable --policy= → positional.
  • content/chainguard/libraries/javascript/migration.md — 1 enable --policy= → positional.

The auto-generated content/platform/chainctl/chainctl-docs/chainctl_libraries_policy_*.md pages are intentionally left untouched; they regenerate from the CLI via AutoDocs.

Open item

access.md still notes that these commands require chainctl v0.2.291 or newer. Positional enable/disable is newer than that (PR 46764 merged 2026-07-16), so the minimum version for the positional form is likely later. The note is left as-is pending confirmation of the release that ships PR 46764.

Test plan

  1. Install a chainctl build containing PR 46764.
  2. chainctl libraries policy create --name=test-cooldown --cooldown-days=3 --parent=<org>
  3. chainctl libraries policy enable test-cooldown --ecosystem=JAVASCRIPT --mode=PREVIEW — confirm the positional name is accepted.
  4. chainctl libraries policy update test-cooldown --block=purl=pkg:npm/lodash — confirm positional works on update.
  5. chainctl libraries policy enable test-cooldown --policy=test-cooldown --ecosystem=JAVASCRIPT — confirm supplying both positional and --policy errors (validates mutual exclusivity).
  6. Run hugo server and confirm the code blocks on all three pages render correctly.

Created in collaboration with Claude Code running Opus 4.8 (1M context) on 2026-07-16.

🤖 Generated with Claude Code

…date

chainctl libraries policy enable/disable now accept the policy name or ID
as a positional argument (chainguard-dev/mono#46764). Update the Libraries
access and migration guides to use the positional form, matching
update/describe/delete. create --name is left unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@s-stumbo
s-stumbo requested a review from a team as a code owner July 16, 2026 18:13
@netlify

netlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Deploy Preview for ornate-narwhal-088216 ready!

Name Link
🔨 Latest commit e03d240
🔍 Latest deploy log https://app.netlify.com/projects/ornate-narwhal-088216/deploys/6a5a46c0223ac1000793fc05
😎 Deploy Preview https://deploy-preview-3599--ornate-narwhal-088216.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@matthewhelmke matthewhelmke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, consistent and clear

Signed-off-by: s-stumbo <sally.stumbo@chainguard.dev>
Sign up for free to 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