Skip to content

Note required entitlement and pull permission for libraries commands - #3710

Merged
s-stumbo merged 3 commits into
mainfrom
chainctl-permissions
Aug 6, 2026
Merged

Note required entitlement and pull permission for libraries commands#3710
s-stumbo merged 3 commits into
mainfrom
chainctl-permissions

Conversation

@s-stumbo

@s-stumbo s-stumbo commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

What this changes

chainctl libraries update-hashes and chainctl libraries verify both require an entitlement to the relevant ecosystem plus the matching pull permission (libraries.java.pull, libraries.javascript.pull, or libraries.python.pull). That requirement wasn't stated where the docs tell readers to run these commands.

This adds a short note at each procedure step across the Python, JavaScript, and Java libraries guides, and to the verification page's Requirements list. Ecosystem-specific pages name only that ecosystem's permission; the ecosystem-agnostic pages (quickstart, verification) list all three.

Auto-generated chainctl reference pages (content/platform/chainctl/chainctl-docs/) and the docs bundle are intentionally excluded.

Also fixes a copy-paste error on the Python global-configuration page that read "all supported JavaScript lockfile formats."

Files touched

  • quickstart.md — Step 4 (verify)
  • verification.md — Requirements list
  • python/migration.md — Steps 2 (update-hashes) and 5 (verify)
  • python/build-configuration.md, python/global-configuration.md — update-hashes
  • javascript/migration.md — Steps 3 (update-hashes) and 6 (verify)
  • javascript/build-configuration.md, javascript/global-configuration.md — update-hashes
  • java/migration.md — Step 6 (verify)
  • java/build-configuration.md — Maven and Gradle cache verify steps

Open item for reviewers

The permission enforced by these commands is documented here as libraries.<ecosystem>.pull, consistent with access.md. If anyone has confirmed hands-on whether update-hashes/verify enforce .pull specifically (versus only requiring a valid pull token created via .pull_token_creator), please confirm on this PR.

Testing plan

  1. Check out this branch and run the site locally (hugo server).
  2. Open each page and confirm the note renders as a blockquote at the command's instruction point:
    • /chainguard/libraries/quickstart/#step-4-verify-your-libraries
    • /chainguard/libraries/verification/#requirements
    • /chainguard/libraries/python/migration/ (Steps 2 and 5)
    • /chainguard/libraries/python/build-configuration/#updating-lockfile-hashes
    • /chainguard/libraries/python/global-configuration/#updating-lockfile-hashes
    • /chainguard/libraries/javascript/migration/ (Steps 3 and 6)
    • /chainguard/libraries/javascript/build-configuration/#authentication
    • /chainguard/libraries/javascript/global-configuration/#updating-lockfile-hashes
    • /chainguard/libraries/java/migration/#step-6-verify-artifacts
    • /chainguard/libraries/java/build-configuration/ (Maven and Gradle verify sections)
  3. On each note, click the entitlement to Chainguard Libraries link and confirm it lands on /chainguard/libraries/access/#entitlement.
  4. Confirm ecosystem-specific pages name only that ecosystem's permission, and quickstart/verification list all three.
  5. Confirm the Python global-configuration page now reads "all supported Python lockfile formats."
  6. Confirm no content/platform/chainctl/chainctl-docs/ page or the docs bundle was modified (git diff --stat main shows only the 10 files above).

🤖 Generated with Claude Code

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

Document that chainctl libraries update-hashes and verify each require an
ecosystem entitlement and the matching libraries.<ecosystem>.pull permission,
adding a note at each procedure step across the Python, JavaScript, and Java
libraries guides. Auto-generated chainctl reference pages are excluded.

Also fix a copy-paste error on the Python global-configuration page that
referred to "JavaScript lockfile formats."

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 August 5, 2026 18:43
@netlify

netlify Bot commented Aug 5, 2026

Copy link
Copy Markdown

Deploy Preview for ornate-narwhal-088216 ready!

Name Link
🔨 Latest commit a6a00df
🔍 Latest deploy log https://app.netlify.com/projects/ornate-narwhal-088216/deploys/6a7489fbc3c0540008240d17
😎 Deploy Preview https://deploy-preview-3710--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.

Reword the update-hashes and verify permission notes to name only the pull
permission or the Owner role, dropping the entitlement mention, and move each
note to immediately after the command code block.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: s-stumbo <sally.stumbo@chainguard.dev>
@s-stumbo
s-stumbo merged commit 45bde30 into main Aug 6, 2026
12 checks passed
@s-stumbo
s-stumbo deleted the chainctl-permissions branch August 6, 2026 13:26
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