Skip to content

Latest commit

 

History

History
72 lines (59 loc) · 3.06 KB

ReleaseInstructions.md

File metadata and controls

72 lines (59 loc) · 3.06 KB

Creating a new svg-edit release

Prepare

  1. npm test - Ensure tests are passing
  2. npm run build-doc - Ensure JSDoc can build
  3. npm run grep-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.

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. Update the README references to svg-edit.github.io to point to the current version (note that it will not be available until the steps below).
  4. Commit these changes
.
  1. Tag the version, prefixed by "v", e.g., v3.0.1.

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

Create the release on gh-pages

  1. Ensure you are on the master branch with git checkout master.
  2. Switch to the gh-pages branch with git checkout gh-pages.
  3. Copy the svg-edit-X.Y directory to releases/svg-edit-X.Y and to latest/ (minus .git and .gitignore and including the working built svgedit-config-es.js and svgedit-config-iife.js files).
  4. Commit these changes with git commit -m "Updating files for release X.Y".
  5. Switch back to the master branch with git checkout master.
  6. Ensure this step worked by visiting https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html (and in an ES6-Module-compliant browser, https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/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 commit where the changes were updated.
  3. Write a short description of the release and include a link to the live version: https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html. See the previous releases for the format.
  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

Update the project docs

Ensure README.md has references and links to the shiny new release. This will probably not be needed if the latest directory continues to be preferred over hard-coding links to particular releases.