svgedit/docs/ReleaseInstructions.md

Creating a new svg-edit release

Prepare

1. npm run browser-test - Ensure build steps occur and tests are passing
2. npm test - This should also be run, though currently accessibility tests are failing
3. npm run build-doc - Ensure JSDoc can build and is available for site build (though not added to master, will be copied over in gh-pages steps and used in npm publish step).
4. npm run types-doc - For JSDoc, we ensure that a minimum of generic types have been added (e.g., "number" should instead be "Float" or "Array", and "object", "function", or "array" should be replaced by more specific @interfaces, @typdefs, or @callback. Deriving types can use PlainObject or GenericArray to indicate the simple base type was intentional. * should also be checked. The script reports all failing matches within editor. There should be none (there is currently one due to our needing to move the file to its own module).
5. npm pack to preview which files will be included once published and taking into account .npmignore. Take care to remove the .tgz tarball file that it creates so it is not itself included during the publishing step.

Update the main project

1. Update version in package.json (and package-lock.json (via npm i)).
2. Update the CHANGES file with a summary of all changes.
3. Add new release info to Recent news section in README
4. Commit these changes

.

1. Tag the version, prefixed by "v", e.g., v4.0.1.

The above steps can be done on a fork and committed via a pull request.

Create the release on gh-pages

1. Switch to the gh-pages branch with git checkout gh-pages.
2. Run the build.js executable (npm run build if within the project root directory); Please note: this script is only available on gh-pages and currently assumes that one has the gh-pages branch checked out within a folder that is in a sibling directory to a folder named svgedit that is on the master branch and whose files and version info will be copied over to gh-pages in making the "latest" and specific version builds
3. Commit these changes with git commit -m "Updating files for release X.Y.Z".
4. Switch back to the master branch with git checkout master.
5. Ensure this step worked by visiting https://svg-edit.github.io/svgedit/releases/svg-edit-X.Y.Z/editor/svg-editor.html (and in an ES6-Module-compliant browser, https://svg-edit.github.io/svgedit/releases/svg-edit-X.Y.Z/editor/svg-editor-es.html).

The above steps can be done on a fork and committed via a pull request.

Create the release on GitHub

1. Go to https://github.com/SVG-Edit/svgedit/releases and select Draft a new release.
2. Make the release target point at the tag where the changes were updated.
3. Write a short description of the release and include a link to the live version (in another tab, you may wish to see the source for a previous release): https://svg-edit.github.io/svgedit/releases/svg-edit-X.Y.Z/editor/svg-editor.html.
4. Create the release!

You will need to be a member of the SVG-Edit GitHub group to do this step.

Publish to npm

1. npm publish

You will need to be a member of the npm group to do this step.