Skip to content

USWDS web-components: Configure publication to NPM #62

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.

Sign up for GitHub

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

Open
heymatthenry wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

USWDS web-components: Configure publication to NPM #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82cf2d6
rm 'private' field, change version
heymatthenry Aug 27, 2024
828ae74
add publishConfig
heymatthenry Aug 27, 2024
ad319a3
Add publish action (develop only)
heymatthenry Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/npm-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Publish npm package
on:
push:
branches:
- develop
Copy link

@mejiaj mejiaj Aug 29, 2024

Choose a reason for hiding this comment

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

question: Should this be on [published] or main?

Going off of example workflow guidance:

name: Publish package to GitHub Packages
on:
  release:
    types: [published]
…

Full source →

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
- run: npm ci
- run: npm publish --provenance --access public --tag develop
Copy link

@mejiaj mejiaj Aug 29, 2024

Choose a reason for hiding this comment

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

praise: Provenance flag is a great idea!

env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "@uswds/web-components",
"private": true,
"version": "1.0.0-alpha",
"version": "0.0.1-alpha",
"type": "module",
"files": [
".storybook",
Expand All @@ -10,6 +9,9 @@
"dist",
"src"
],
"publishConfig": {
"access": "public"
},
"exports": {
".": {
"import": "./dist/components/index.js",
Expand Down