npm run browser-test
- Ensure build steps occur and tests are passingnpm test
- This should also be run, though currently accessibility testsnpm run build-doc
- Ensure JSDoc can build and is available for sitemaster
, will be copied over in gh-pages
npm publish
step).npm run types-doc
- For JSDoc, we ensure that a minimum of generic types@interface
s, @typdef
s, or @callback
. Deriving types can usePlainObject
or GenericArray
to indicate the simple base type was*
should also be checked. The script reports all failingeditor
. There should be none (there is currently onenpm pack
to preview which files will be included once published and.npmignore
. Take care to remove the .tgz
tarballversion
in package.json
(and package-lock.json
(via npm i
)).Recent news
section in READMEv3.0.1
.The above steps can be done on a fork and committed via a pull request.
gh-pages
gh-pages
branch with git checkout gh-pages
.build.js
executable (npm run build
if within the project rootgh-pages
andgh-pages
branch checked out withinsvgedit
thatmaster
branch and whose files and version info will be copiedgh-pages
in making the "latest" and specific version buildsgit commit -m "Updating files for release X.Y.Z"
.master
branch with git checkout master
.The above steps can be done on a fork and committed via a pull request.
Draft a new release
.You will need to be a member of the SVG-Edit GitHub group to do this step.
npm publish
You will need to be a member of the npm group to do this step.