Skip to content

Add OIDC publishing setup to wizard and documentation#4

Merged
aarongustafson merged 5 commits intomainfrom
copilot/add-oidc-setup-note
Dec 2, 2025
Merged

Add OIDC publishing setup to wizard and documentation#4
aarongustafson merged 5 commits intomainfrom
copilot/add-oidc-setup-note

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 2, 2025

The setup wizard and documentation lacked guidance on configuring OIDC for automated npm publishing via GitHub Actions.

Changes

  • Setup wizard output: Added publishing setup reminder displaying OIDC configuration steps and npm package settings URL
  • README.md: Replaced NPM_TOKEN instructions with OIDC-based publishing workflow including initial manual publish requirement, trusted publisher configuration, and recommended use of npm version with git push --follow-tags for version management
  • README.tpl: No changes - Publishing section remains only in template repository documentation, not in generated component READMEs

Example Output

After running npm run setup, users now see:

📦 Publishing Setup:

  Before you can publish to npm via GitHub Actions, you need to:
  1. Publish your package to npm at least once manually
  2. Configure OIDC for automated publishing
  3. Visit your package on npm and go to Settings > Publishing Access
     (https://www.npmjs.com/package/@yourscope/your-package-name/access)
  4. Under "Publishing Access", add GitHub Actions as a trusted publisher
  5. Set up with your repository details

  See README.md for detailed publishing instructions.
Original prompt

This section details on the original issue you should resolve

<issue_title>Add a note to the setup process to set up OIDC</issue_title>
<issue_description>Add a reminder at the end of the setup process on the command line with a link to the eventually URL to access the settings page for the component on npm.

Update the README to give the correct publish process using OIDC.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits December 2, 2025 19:56
Co-authored-by: aarongustafson <75736+aarongustafson@users.noreply.github.com>
Co-authored-by: aarongustafson <75736+aarongustafson@users.noreply.github.com>
Co-authored-by: aarongustafson <75736+aarongustafson@users.noreply.github.com>
Copilot AI changed the title [WIP] Add note for OIDC setup process and update README Add OIDC publishing setup to wizard and documentation Dec 2, 2025
Copilot AI requested a review from aarongustafson December 2, 2025 20:05
Copy link
Copy Markdown
Owner

@aarongustafson aarongustafson left a comment

Choose a reason for hiding this comment

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

@copilot Please address the feedback

- **Workflow**: `.github/workflows/publish.yml`
- **Environment**: Leave blank (unless you use GitHub environments)

3. Create a GitHub release to trigger automated publishing:
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@copilot Recommend npm version and git push --follow-tags

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated to use npm version patch (or minor/major) and git push --follow-tags in commit 3c53290.

README.tpl Outdated
open demo/index.html
```

## Publishing
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@copilot You don’t need this section added to the template. The template is intended for use with the component itself.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed the Publishing section from README.tpl in commit 3c53290. The OIDC instructions now only appear in the setup wizard output and the template repository's README.md.

Co-authored-by: aarongustafson <75736+aarongustafson@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Dec 2, 2025

@copilot Please address the feedback

All feedback addressed in commit 3c53290:

  • Updated README.md to recommend npm version and git push --follow-tags
  • Removed Publishing section from README.tpl (now only in template repository's documentation)

@aarongustafson aarongustafson marked this pull request as ready for review December 2, 2025 23:40
@aarongustafson aarongustafson merged commit d850898 into main Dec 2, 2025
0 of 6 checks passed
@aarongustafson aarongustafson deleted the copilot/add-oidc-setup-note branch December 2, 2025 23:40
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.

Add a note to the setup process to set up OIDC

2 participants