-
Notifications
You must be signed in to change notification settings - Fork 72
chore(docs) Adds OIDC docs #3374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 Changeset detectedLatest commit: e9164c6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the repository to use npm trusted publishing with OIDC and upgrades the Node.js version from 18 to 22. The changes add documentation and CLI guidance to inform developers that new packages require a manual first publish before automated releases can take over.
Key changes:
- Upgraded Node.js requirement from 18.20.8 to 22.21.0/22.21.1
- Added comprehensive documentation about OIDC-based publishing workflow
- Implemented CLI instructions that display after package creation
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
package.json |
Updates minimum Node.js version to 22.21.0 |
.tool-versions |
Updates Node.js version to 22.21.1 |
.github/workflows/*.yml |
Updates all GitHub Actions workflows to use Node 22 |
tools/create/src/utils/printInitialPublishInstructions.ts |
New utility function to print initial publish instructions |
tools/create/src/index.ts |
Integrates the new print function into package creation flow |
tools/create/README.md |
Adds documentation for OIDC publishing requirements |
README.md |
Expands initial release section with detailed OIDC setup steps |
DEVELOPER.md |
Adds comprehensive section on publishing new packages with OIDC |
.changeset/create-oidc-docs.md |
Documents the changes as a minor version bump |
|
Size Change: +274 B (+0.02%) Total Size: 1.81 MB
ℹ️ View Unchanged
|
stephl3
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like we're duplicating the docs across multiple spots. Can we keep them in a single spot and then link to the appropriate section(s) where necessary? Worried about stale docs since it will be difficult to know to update multiple files
I did that intentionally to make sure it was in the relevant places, but your concern about getting stale is valid/. I'll update |
…arity and consistency
|
Coverage after merging at/oidc-docs into main will be
Coverage Report for Changed Files
|
Adds Docs for #3369
Adds warning in
createtool'@lg-tools/create': patch
Add CLI output and documentation for npm trusted publishing (OIDC) initial publish requirement