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

Create ReleaseInstructions.md

master
Philip Rogers 2015-11-24 16:53:55 -08:00
parent 98523876f3
commit b0f1cee47a
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/ReleaseInstructions.md Normal file
View File

@ -0,0 +1,39 @@
Creating a new svg-edit release
============
## Update the main project
1. Update the VERSION variable in Makefile.
2. Update the CHANGES file with a summary of all changes.
3. Commit these changes with `git commit -m "Updating Makefile and CHANGES for release X.Y"`.
The above steps can be done on a fork and committed via a pull request.
## Create the release binaries
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.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. Copy `svg-edit-X.Y.tar.gz` and `svg-edit-X.Y.zip` to `compressed/svg-edit-X.Y.tar.gz` and `compressed/svg-edit-X.Y.zip`.
7. Commit these changes with `git commit -m "Updating binary files for release X.Y"`.
8. Switch back to the `master` branch with `git checkout master`.
9. 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. Attach the `svg-edit-X.Y.zip` and `compressed/svg-edit-X.Y.tar.gz` files to the release.
5. Create the release!
You will need to be a member of the SVGEdit GitHub group to do this step.
## Update the project docs
Update `README.md` and add a reference to your shiny new release.