automate npm publish #1427
automate npm publish #1427
Conversation
GH workflow action which, on successful test and build steps on master branch, will publish to npm registry J=SLAP-1353 TEST=manual created mock repo and npm package, made a new tagged release and verified it automatically publish to npm test package.
.github/workflows/npm_publish.yml
Outdated
| with: | ||
| node-version: ${{ matrix.node-version }} | ||
| - run: npm ci | ||
| - run: npm run test |
There was a problem hiding this comment.
Do we need to include the test here? If the tests fail will the publish fail? There shouldn't be code in master that fails our tests.
There was a problem hiding this comment.
ah I added it in as a safety check, but if we already verify that before pushing to master then I guess this step is not necessary.
| node-version: ${{ matrix.node-version }} | ||
| registry-url: https://registry.npmjs.org/ | ||
| - run: npm ci | ||
| - run: npm run build |
There was a problem hiding this comment.
Just for my edification, we're not including the contents of src or test in what we publish to NPM, right? We're essentially just publishing the dist directory and some manifest files (package.json, etc.)
There was a problem hiding this comment.
Currently we include everything except the things specified in .npmignore. In answers-core, we instead use the 'files' param in package.json to specify which files and folders to include. I think we should switch answers-search-ui to do that as well. I think the dist folder is the only one we need
There was a problem hiding this comment.
I made the change in package.json to include dist/ folder only (npm will also automatically include package.json, license, and readme file when publish)
There was a problem hiding this comment.
With the files addition to the package.json do we still need .npmignore?
There was a problem hiding this comment.
Good point. Would need it if we want to exclude something specific from files, but since node_modules is automatically ignored and DS_Store is never going to be push to repo, I will remove .npmignore
yen-tt
force-pushed
the
dev/automate-npm-publish
branch
from
8b1ef00
to
b1a9f78
Compare
yen-tt
force-pushed
the
dev/automate-npm-publish
branch
from
b1a9f78
to
421475b
Compare
GH workflow action which, on successful test and build steps on master branch, will publish to npm registry
J=SLAP-1353
TEST=manual
created mock repo and npm package, made a new tagged release and verified it automatically publish to npm test package.