Skip to content

Commit

Permalink
- npm: Bump to 3.0.0-rc.1
Browse files Browse the repository at this point in the history
- Docs: No longer need to update `svg-edit.github.io` as referencing "latest" but add note to add to "Recent news"
  • Loading branch information
brettz9 committed Jul 19, 2018
1 parent 0a25236 commit bee5870
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 25 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ?
# 3.0.0-rc.1

- Security fix: 'extPath', 'imgPath', 'extIconsPath', 'canvgPath',
'langPath', 'jGraduatePath', and 'jspdfPath' were not being prevented
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,17 @@ incorporating SVGEdit.
to have the changes properly copied to `svg-editor.html`.

## Recent news
* 2018-05-26 Published 3.0.0-alpha.2 with ES6 Modules support
* 2017-07 Added to Packagist: https://packagist.org/packages/svg-edit/svgedit
* 2015-12-02 SVG-edit 2.8.1 was released.
* 2015-11-24 SVG-edit 2.8 was released.
* 2015-11-24 Code, issue tracking, and docs are being moved to github (previously [code.google.com](https://code.google.com/p/svg-edit)).
* 2014-04-17 2.7 and stable branches updated to reflect 2.7.1 important bug fixes for the embedded editor.
* 2014-04-07 SVG-edit 2.7 was released.
* 2013-01-15 SVG-edit 2.6 was released.

- 2018-07-19 Published 3.0.0-rc.1 allowing for extensions and locales to be
expressed as modules
- 2018-05-26 Published 3.0.0-alpha.2 with ES6 Modules support
- 2017-07 Added to Packagist: https://packagist.org/packages/svg-edit/svgedit
- 2015-12-02 SVG-edit 2.8.1 was released.
- 2015-11-24 SVG-edit 2.8 was released.
- 2015-11-24 Code, issue tracking, and docs are being moved to github (previously [code.google.com](https://code.google.com/p/svg-edit)).
- 2014-04-17 2.7 and stable branches updated to reflect 2.7.1 important bug fixes for the embedded editor.
- 2014-04-07 SVG-edit 2.7 was released.
- 2013-01-15 SVG-edit 2.6 was released.

## Videos

Expand Down
22 changes: 8 additions & 14 deletions docs/ReleaseInstructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,17 @@
`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.
1. Preview which files will be included once published (taking into
account `.npmignore`), by using `npm pack` (taking care to remove
the `.tgz` tarball file that it creates).

## Update the main project
<!--
1. Update the VERSION variable in Makefile.
-->
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 references to `svg-edit.github.io` to point to the
current version (note that it will not be available until the steps below).
1. Add new release info to `Recent news` section in README
1. Commit these changes
<!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y"`-->.
1. Tag the version, prefixed by "v", e.g., `v3.0.1`.
Expand All @@ -39,9 +41,10 @@ The above steps can be done on a fork and committed via a pull request.
`svgedit-config-es.js` and `svgedit-config-iife.js` files).
1. Commit these changes with `git commit -m "Updating files for release X.Y"`.
1. Switch back to the `master` branch with `git checkout master`.
1. 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>).
1. 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.

Expand All @@ -63,13 +66,4 @@ You will need to be a member of the SVG-Edit GitHub group to do this step.

## Publish to npm

1. To preview which files will be included once published (taking into
account `.npmignore`), you may use `npm pack` (taking care to remove
the `.tgz` tarball file that it creates).
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.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "svgedit",
"version": "3.0.0-alpha.4",
"version": "3.0.0-rc.1",
"description": "Powerful SVG-Editor for your browser ",
"main": "dist/index-umd.js",
"module": "dist/index-es.js",
Expand Down

0 comments on commit bee5870

Please sign in to comment.