From f6005d6ac5726b5179a902a20fa442a546415fef Mon Sep 17 00:00:00 2001 From: Philip Rogers Date: Tue, 24 Nov 2015 18:41:38 -0800 Subject: [PATCH] Update instructions to use binary attachments Instead of storing compressed zip and tar.gz files on gh-pages, just link directly to them from the releases page (https://github.com/progers/svgedit/releases). --- docs/ReleaseInstructions.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/ReleaseInstructions.md b/docs/ReleaseInstructions.md index 1cf364b9..e650f586 100644 --- a/docs/ReleaseInstructions.md +++ b/docs/ReleaseInstructions.md @@ -13,13 +13,12 @@ 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`. 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. + 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. 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 + 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 The above steps can be done on a fork and committed via a pull request. @@ -29,11 +28,11 @@ The above steps can be done on a fork and committed via a pull request. 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. + 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. ## Update the project docs - Update `README.md` and add a reference to your shiny new release. + Update `README.md` with references and links to the shiny new release.