From 3b04fe0c63de0dd8432b60f5dfbe3bf87cd63d5f Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Wed, 30 May 2018 10:57:28 +0800 Subject: [PATCH] - 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 --- CHANGES.md | 9 +++++++ README.md | 2 ++ docs/ReleaseInstructions.md | 51 +++++++++++++++++++++---------------- package-lock.json | 2 +- package.json | 2 +- 5 files changed, 42 insertions(+), 24 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 72376c26..ca3da14e 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,12 @@ +# 3.0.0-alpha.4 + +- Docs: Convert more docs to JSDoc and add JSDoc script (thanks, tetedacier!) +- Fix `main` on `package.json` to reference UMD distribution and `module` + to point to ES6 Module dist +- Fix (regression): Bad name on function passed to `path.js` +- Fix (regression): Star tool (radialshift) +- Fix (regression): Favicon setting + # 3.0.0-alpha.3 - Change: Default to stylesheet above `editor` directory diff --git a/README.md b/README.md index 0b4478e5..b7e076bc 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ SVG-edit is a fast, web-based, javascript-driven SVG drawing editor that works i (Also available as a [download](https://github.com/SVG-Edit/svgedit/releases/download/svg-edit-2.8.1/svg-edit-2.8.1.zip) in [releases](https://github.com/SVG-Edit/svgedit/releases)). +You may also try the [pre-release](https://svg-edit.github.io/svgedit/releases/svg-edit-3.0.0-alpha.4/editor/svg-editor.html) (or the [ES6-Module](https://svg-edit.github.io/svgedit/releases/svg-edit-3.0.0-alpha.4/editor/svg-editor.html) version, assuming a modern browser). + ## Installation Note that steps 1-2 below are only necessary if you wish to integrate diff --git a/docs/ReleaseInstructions.md b/docs/ReleaseInstructions.md index 0479e9d4..b027be31 100644 --- a/docs/ReleaseInstructions.md +++ b/docs/ReleaseInstructions.md @@ -1,37 +1,44 @@ # Creating a new svg-edit release ## Update the main project - - 1. Update the VERSION variable in Makefile. - 2. Update `version` in `package.json` - 3. Update the CHANGES file with a summary of all changes. - 4. Commit these changes with `git commit -m "Updating Makefile and CHANGES for release X.Y"`. + +1. Update `version` in `package.json` (and `package-lock.json` (via `npm i`)) +1. Update the CHANGES file with a summary of all changes. +1. Update the README to point to the current version (it will not be available until the steps below) +1. 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 binaries +## Create the release on `gh-pages` + - 1. Ensure you are on the `master` branch with `git checkout master`. - 2. From the root directory run `make`. - 3. Copy `build/svg-edit-X.Y/`, `build/svg-edit-X.Y-src.tar.gz`, and `build/svg-edit-X.Y.zip` to a temporary directory. - 4. Switch to the `gh-pages` branch with `git checkout gh-pages`. - 5. Copy the `svg-edit-X.Y` directory to `releases/svg-edit-X.Y`. - 6. Commit these changes with `git commit -m "Updating binary files for release X.Y"`. - 7. Switch back to the `master` branch with `git checkout master`. - 8. Ensure this step worked by visiting https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html +1. Ensure you are on the `master` branch with `git checkout master`. +1. Switch to the `gh-pages` branch with `git checkout gh-pages`. +1. Copy the `svg-edit-X.Y` directory to `releases/svg-edit-X.Y`. +1. Commit these changes with `git commit -m "Updating binary files for release X.Y"`. +1. Switch back to the `master` branch with `git checkout master`. +1. Ensure this step worked by visiting The above steps can be done on a fork and committed via a pull request. ## Create the release on GitHub + +1. Go to and select `Draft a new release`. +1. Make the release target point at the commit where the makefile and changes were updated. +1. Write a short description of the release and include a link to the live version: + +1. Create the release! - 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. Attach the `svg-edit-X.Y-src.tar.gz` and `build/svg-edit-X.Y.zip` files to the release. - 5. Create the release! - -You will need to be a member of the SVGEdit GitHub group to do this step. +You will need to be a member of the SVG-Edit GitHub group to do this step. ## Publish to npm diff --git a/package-lock.json b/package-lock.json index 72e74c62..03e4c764 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "svgedit", - "version": "3.0.0-alpha.3", + "version": "3.0.0-alpha.4", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 85ad13a3..56c08eaf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "svgedit", - "version": "3.0.0-alpha.3", + "version": "3.0.0-alpha.4", "description": "Powerful SVG-Editor for your browser ", "main": "dist/index-umd.js", "module": "dist/index-es.js",