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

- Docs: Add README link to pre-release

Browse Source 
- 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
This commit is contained in:
Brett Zamir
2018-05-30 10:57:28 +08:00
parent 2ddc78d525
commit 3b04fe0c63
5 changed files with 42 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
docs/ReleaseInstructions.md
View File

@@ -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 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 to point to the current version (it will not be available until the steps below)
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`.
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`
<!--
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.
-->
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 <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
<!--
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. 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>
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