From 859d09c1be5ab2ffee2ffa58fb8df0b165e00456 Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Mon, 13 Jul 2020 08:46:23 +0800 Subject: [PATCH] - docs: Update release instructions - npm: work on release scripts - submodules: Add old versions as submodules for availability on Github Pages --- .gitmodules | 16 ++++------------ docs/ReleaseInstructions.md | 12 ++++++++---- package-lock.json | 9 +++++++++ package.json | 5 +++-- releases/svg-edit-2.8 | 1 + releases/svg-edit-2.8.1 | 1 + releases/svg-edit-3.0.0 | 1 + releases/svg-edit-3.0.0-alpha.1 | 1 + releases/svg-edit-3.0.0-alpha.2 | 1 + releases/svg-edit-3.0.0-alpha.3 | 1 + releases/svg-edit-3.0.0-alpha.4 | 1 + releases/svg-edit-3.0.0-rc.1 | 1 + releases/svg-edit-3.0.0-rc.2 | 1 + releases/svg-edit-3.0.0-rc.3 | 1 + releases/svg-edit-3.0.1 | 1 + releases/svg-edit-3.1.0 | 1 + releases/svg-edit-3.1.1 | 1 + releases/svg-edit-3.2.0 | 1 + releases/svg-edit-4.0.0 | 1 + releases/svg-edit-4.0.1 | 1 + releases/svg-edit-4.1.0 | 1 + releases/svg-edit-4.2.0 | 1 + releases/svg-edit-4.3.0 | 1 + releases/svg-edit-5.0.0 | 1 + releases/svg-edit-5.1.0 | 1 + 25 files changed, 45 insertions(+), 18 deletions(-) create mode 160000 releases/svg-edit-2.8 create mode 160000 releases/svg-edit-2.8.1 create mode 160000 releases/svg-edit-3.0.0 create mode 160000 releases/svg-edit-3.0.0-alpha.1 create mode 160000 releases/svg-edit-3.0.0-alpha.2 create mode 160000 releases/svg-edit-3.0.0-alpha.3 create mode 160000 releases/svg-edit-3.0.0-alpha.4 create mode 160000 releases/svg-edit-3.0.0-rc.1 create mode 160000 releases/svg-edit-3.0.0-rc.2 create mode 160000 releases/svg-edit-3.0.0-rc.3 create mode 160000 releases/svg-edit-3.0.1 create mode 160000 releases/svg-edit-3.1.0 create mode 160000 releases/svg-edit-3.1.1 create mode 160000 releases/svg-edit-3.2.0 create mode 160000 releases/svg-edit-4.0.0 create mode 160000 releases/svg-edit-4.0.1 create mode 160000 releases/svg-edit-4.1.0 create mode 160000 releases/svg-edit-4.2.0 create mode 160000 releases/svg-edit-4.3.0 create mode 160000 releases/svg-edit-5.0.0 create mode 160000 releases/svg-edit-5.1.0 diff --git a/.gitmodules b/.gitmodules index c06278a8..c87dced8 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,7 +1,3 @@ -[submodule "releases/svg-edit-2.8"] - path = releases/svg-edit-2.8 - url = https://github.com/SVG-Edit/svgedit.git - branch = release-v2.8 [submodule "releases/svg-edit-2.8.1"] path = releases/svg-edit-2.8.1 url = https://github.com/SVG-Edit/svgedit.git @@ -78,15 +74,11 @@ path = releases/svg-edit-5.0.0 url = https://github.com/SVG-Edit/svgedit.git branch = release-v5.0.0 +[submodule "releases/svg-edit-2.8"] + path = releases/svg-edit-2.8 + url = https://github.com/SVG-Edit/svgedit.git + branch = release-v2.8 [submodule "releases/svg-edit-5.1.0"] path = releases/svg-edit-5.1.0 url = https://github.com/SVG-Edit/svgedit.git branch = release-v5.1.0 -[submodule "releases/svg-edit-6.0.0"] - path = releases/svg-edit-6.0.0 - url = https://github.com/SVG-Edit/svgedit.git - branch = release-v6.0.0 -[submodule "releases/latest"] - path = releases/latest - url = https://github.com/SVG-Edit/svgedit.git - branch = release-v6.0.0 diff --git a/docs/ReleaseInstructions.md b/docs/ReleaseInstructions.md index 5d949ded..c65c1e22 100644 --- a/docs/ReleaseInstructions.md +++ b/docs/ReleaseInstructions.md @@ -27,11 +27,15 @@ The above steps can be done on a fork and committed via a pull request. ## Create the release as a submodule -1. Create a branch for the release, e.g., `git branch release-v6.0.0` +1. Create a branch for the release, e.g., `git branch release-v6.0.0` and + push it to origin. 1. While still on `master`, run the following (changing the version). This - will add the branch to `.gitsubmodules` and have it point `latest` to - this new release: - `VERSION=6.0.0 npm run add-release` + will add the branch to `.gitsubmodules` and have the current version in + `package.json` point `latest` to this new release: + `npm run add-new-release`; if you need to add a specific version (e.g., + an older one that was missing, use the following): + `npm run add-release --release=6.0.0`. If you need to remove a release, + run `npm run remove-release --release=6.0.0` 1. Commit these changes `git commit -m "Updating for release X.Y.Z"`-->. 1. Push to `master`. 1. Ensure the new release is available by visiting diff --git a/package-lock.json b/package-lock.json index cfc9190e..b29f0b61 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6644,6 +6644,15 @@ "sha.js": "^2.4.8" } }, + "cross-env": { + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-7.0.2.tgz", + "integrity": "sha512-KZP/bMEOJEDCkDQAyRhu3RL2ZO/SUVrxQVI0G3YEQ+OLbRA3c6zgixe8Mq8a/z7+HKlNEjo8oiLUs8iRijY2Rw==", + "dev": true, + "requires": { + "cross-spawn": "^7.0.1" + } + }, "cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", diff --git a/package.json b/package.json index 6c9e150a..a0cada08 100644 --- a/package.json +++ b/package.json @@ -13,8 +13,9 @@ "node": ">=8.5.0" }, "scripts": { - "add-release": "cross-var git submodule add --depth=1 -b \"release-v$npm_package_version\" -- https://github.com/SVG-Edit/svgedit.git \"releases/svg-edit-$npm_package_version\"", - "add-new-release": "npm run add-release && cross-var git config --file=.gitmodules submodule.releases/latest.branch \"release-v$npm_package_version\"", + "add-release": "git submodule add --depth=1 -b \"release-v$npm_config_release\" -- https://github.com/SVG-Edit/svgedit.git \"releases/svg-edit-$npm_config_release\"", + "add-new-release": "cross-var npm run add-release --release=$npm_package_version && cross-var git config --file=.gitmodules submodule.releases/latest.branch \"release-v$npm_package_version\"", + "remove-release": "git submodule deinit -f \"releases/svg-edit-$npm_config_release\" && rm -rf .git/modules/releases/svg-edit-$npm_config_release && git rm -f releases/svg-edit-$npm_config_release", "submodules": "run-s submodules-init submodules-update", "submodules-init": "echo \"Performing non-recursive init as don't want submodules to have their own releases!\" && git submodule update --init", "submodules-update": "echo \"Performing non-recursive fetch as don't want submodules to have their own releases!\" && git submodule foreach git fetch && git submodule update --remote && git submodule foreach git merge origin master", diff --git a/releases/svg-edit-2.8 b/releases/svg-edit-2.8 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-2.8 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-2.8.1 b/releases/svg-edit-2.8.1 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-2.8.1 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0 b/releases/svg-edit-3.0.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-alpha.1 b/releases/svg-edit-3.0.0-alpha.1 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-alpha.1 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-alpha.2 b/releases/svg-edit-3.0.0-alpha.2 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-alpha.2 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-alpha.3 b/releases/svg-edit-3.0.0-alpha.3 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-alpha.3 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-alpha.4 b/releases/svg-edit-3.0.0-alpha.4 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-alpha.4 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-rc.1 b/releases/svg-edit-3.0.0-rc.1 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-rc.1 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-rc.2 b/releases/svg-edit-3.0.0-rc.2 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-rc.2 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.0-rc.3 b/releases/svg-edit-3.0.0-rc.3 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.0-rc.3 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.0.1 b/releases/svg-edit-3.0.1 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.0.1 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.1.0 b/releases/svg-edit-3.1.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.1.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.1.1 b/releases/svg-edit-3.1.1 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.1.1 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-3.2.0 b/releases/svg-edit-3.2.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-3.2.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-4.0.0 b/releases/svg-edit-4.0.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-4.0.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-4.0.1 b/releases/svg-edit-4.0.1 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-4.0.1 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-4.1.0 b/releases/svg-edit-4.1.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-4.1.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-4.2.0 b/releases/svg-edit-4.2.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-4.2.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-4.3.0 b/releases/svg-edit-4.3.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-4.3.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-5.0.0 b/releases/svg-edit-5.0.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-5.0.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba diff --git a/releases/svg-edit-5.1.0 b/releases/svg-edit-5.1.0 new file mode 160000 index 00000000..facefa43 --- /dev/null +++ b/releases/svg-edit-5.1.0 @@ -0,0 +1 @@ +Subproject commit facefa435170d67b38c43836c7a6834c2c5765ba