zcy
/
svgedit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Docs (ReleaseInstructions): Avoid referencing binary files for now; 

include mention of ES6 Module HTML file and need to copy
    config files (without `.git`/`.gitignore` files); mention reviewing
    Github release format
master
Brett Zamir 2018-05-30 11:08:19 +08:00
parent 3b04fe0c63
commit f1bdd668c6
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/ReleaseInstructions.md
View File

@ -21,10 +21,14 @@ The above steps can be done on a fork and committed via a pull request.
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. Copy the `svg-edit-X.Y` directory to `releases/svg-edit-X.Y` (minus
`.git` and `.gitignore` and including the working built
`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>)
The above steps can be done on a fork and committed via a pull request.
@ -33,9 +37,10 @@ The above steps can be done on a fork and committed via a pull request.
4. Attach the `svg-edit-X.Y-src.tar.gz` and `build/svg-edit-X.Y.zip` files to the release.
-->
1. Go to <https://github.com/SVG-Edit/svgedit/releases> and select `Draft a new release`.
1. Make the release target point at the commit where the makefile and changes were updated.
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:
<https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>
<https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>.
See the previous releases for the format.
1. Create the release!
You will need to be a member of the SVG-Edit GitHub group to do this step.