docs: install OpenChoreo plugins from public npm - #848
Open
kaviththiranga wants to merge 1 commit into
Open
Conversation
@openchoreo/* now ships to the public npm registry, so installing no longer needs a classic PAT with read:packages or an npmScopes block. Keeps the npmMinimalAgeGate guidance, which still applies. Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to openchoreo/backstage-plugins#771, which moves
@openchoreo/*from GitHub Packages to the public npm registry.Installing the plugins no longer requires a classic PAT with
read:packages, annpmScopesblock, or any registry configuration —yarn addworks against a default registry setup.All 24 packages are already live on npm (
latestat1.2.4), so these instructions are accurate as of today rather than pending the plugins PR merging.Changes
installing-into-existing-backstage.mdx(current, v1.2.x, v1.1.x)npmMinimalAgeGate/npmPreapprovedPackagesguidance is kept — the 3-day age gate still blocks freshly published releases, and it matters more on public npm than it did before.npm audit signatures.troubleshooting.mdx(current, v1.2.x, v1.1.x): reworded theportal:fix, which referenced installing from GitHub Packages.#authenticate-to-github-packagesanchor together with its only inbound link, and updated the Section 9 legacy cross-reference that named "GitHub Packages auth".Version accuracy
Versions
1.1.0through1.2.xwere migrated to npm, so the v1.1.x and v1.2.x versioned docs correctly point there. Versions older than1.1.0were not migrated and remain on GitHub Packages —versioned_docs/version-v1.0.xand older never mentioned the registry, so they need no change.Migrated versions carry no provenance attestation because they predate trusted publishing; only
1.3.0onward will be attested. Both facts are stated in the docs rather than glossed over.Verification
npm run buildpasses with no broken links (the removed anchor and its inbound link were deleted together).Note for reviewers
#818 is open against the same install guide and will likely conflict. Happy to rebase whichever merges second.