Files
svgedit/docs/ReleaseInstructions.md
Brett Zamir 3b04fe0c63 - Docs: Add README link to pre-release
- Docs (ReleaseInstructions): Comment out Makefile-related instructions for now and
    add to-dos (README referencing current version and `package-lock.json`, tagging)
- npm: Bump to 3.0.0-alpha.4
2018-05-30 10:57:28 +08:00

2.0 KiB

Creating a new svg-edit release

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 to point to the current version (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.
  4. Commit these changes with git commit -m "Updating binary 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

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 makefile and 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
  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

Update README.md with references and links to the shiny new release.