Improved version management

Signed-off-by: Gary Kim <[email protected]>

Author: gary-kim

CONTRIBUTING.md

@@ -85,6 +85,16 @@ For a new file, add this license header to the top of the file:
  */
 ```
 
+### Make a new release
+
+1. Ensure that all CI tests pass on the latest commit.
+2. Update the version number with `npm version [major|minor|patch] --no-git` and update the version name manually in [package.json](package.json).
+3. Run `npm ci` to install all dependencies for building from [package-lock.json](package-lock.json).
+4. Update [CHANGELOG.md](CHANGELOG.md) with the update changelog for the new version.
+5. Make a new git commit and tag with `git commit -S`,  `git tag VERSION -a`, add the new version name as the annotation, then run `git push origin VERSION`.
+6. Run `npm run clean`, `npm run webpack:build:firefox`, then `npm run package`. Upload the resulting package to [AMO](https://addons.mozilla.org/en-US/developers/addons) to have the extension signed. Upload the result into GitHub releases then update the update server to point to the new release.
+7. Run `npm run clean`, `npm run webpack:build:chromium`, then `npm run package`. Upload the resulting package to [CWS](https://chrome.google.com/webstore/developer/dashboard) to have the new version signed and released.
+
 ### Developer Certificate of Origin
 ```
 Developer Certificate of Origin

nightwatch.conf.js

@@ -24,7 +24,7 @@
 
 const fs = require('fs');
 const JSZip = require('jszip');
-const manifest = require('./src/manifest.json');
+const manifest = require('./dist/manifest.json');
 
 module.exports = {
     src_folders: ['tests'],
@@ -64,6 +64,9 @@ module.exports = {
 };
 
 function generateFirefoxProfile() {
+	if (!manifest.applications){
+		return;
+	}
 	const zip = new JSZip();
 	zip.file(`extensions/${manifest.applications.gecko.id}.xpi`, fs.readFileSync(`artifacts/sas_powerschool_enhancement_suite-${manifest.version}.zip`));
 	zip.file('prefs.js', 'user_pref("xpinstall.signatures.required", false);');

package.json

@@ -1,6 +1,8 @@
 {
   "name": "saspes",
   "version": "1.7.2",
+  "version_name": "Open Beta 0.1.7.2",
+  "private": true,
   "description": "SAS Powerschool Enhancement Suite",
   "main": "index.js",
   "scripts": {

src/manifest - chromium.json

@@ -2,8 +2,8 @@
     "manifest_version": 2,
     "name": "SAS Powerschool Enhancement Suite",
     "short_name": "SAS PES",
-    "version": "0.1.7.2",
-    "version_name": "Public Beta 0.1.7.2",
+    "version": "SET_DURING_BUILD",
+    "version_name": "SET_DURING_BUILD",
     "author": "Gary Kim",
     "homepage_url": "https://github.com/gary-kim/saspes/",
     "description": "Provides various enhancements for SAS Powerschool",

src/manifest.json

@@ -2,7 +2,7 @@
     "manifest_version": 2,
     "name": "SAS Powerschool Enhancement Suite",
     "short_name": "SAS PES",
-    "version": "0.1.7.2",
+    "version": "SET_DURING_BUILD",
     "author": "Gary Kim",
     "homepage_url":"https://github.com/gary-kim/saspes/",
     "description": "Provides various enhancements for SAS Powerschool",

tests/extensionInfo.js

@@ -22,12 +22,18 @@
  * 
  */
 
+const package = require('../package.json');
 
 module.exports = {
     "Show Extension Info": browser => {
         browser
             .url("https://powerschool.sas.edu.sg")
             .waitForElementVisible("#saspes-info")
-            .end();
+    },
+    "Extension Version Correct": browser => {
+        browser
+            .assert.containsText('#saspes-info', 'SAS Powerschool Enhancement Suite')
+            .assert.containsText("#saspes-info", `Version: ${package.version}`)
+            .end()
     }
-}
+}

webpack.chromium.js

@@ -1,13 +1,21 @@
 const merge = require('webpack-merge');
 const common = require('./webpack.common.js');
+const helpers = require('./webpack.helpers.js');
 const CopyPlugin = require('copy-webpack-plugin');
+const package = require('./package.json');
 const path = require('path');
 
 module.exports = merge(common, {
     mode: 'production',
     plugins: [
         new CopyPlugin([
-            { from: path.join(__dirname, 'src', 'manifest - chromium.json'), to: 'manifest.json'}
+            {
+                from: path.join(__dirname, 'src', 'manifest - chromium.json'),
+                to: 'manifest.json',
+                transform(content) {
+                    return helpers.setManifestVersion(content, package.version, package.version_name)
+                }
+            }
         ])
     ]
 });

webpack.common.js

@@ -1,6 +1,8 @@
 const path = require('path');
 const CopyPlugin = require('copy-webpack-plugin');
-const { VueLoaderPlugin } = require('vue-loader')
+const { VueLoaderPlugin } = require('vue-loader');
+const webpack = require('webpack');
+const package = require('./package.json');
 
 module.exports = {
     entry: {
@@ -38,7 +40,10 @@ module.exports = {
         new CopyPlugin([
             { from: "src", to: '', ignore: ['*.js', 'js/**', 'manifest.json', 'manifest - chromium.json', '.eslintrc.json']}
         ]),
-        new VueLoaderPlugin()
+        new VueLoaderPlugin(),
+        new webpack.DefinePlugin({
+            "EXTENSION_VERSION_NAME": JSON.stringify(package.version_name)
+        })
     ],
     resolve: {
         extensions: ['.js', '.vue']

webpack.firefox.js

@@ -1,13 +1,21 @@
 const merge = require('webpack-merge');
 const common = require('./webpack.common.js');
+const helpers = require('./webpack.helpers.js');
 const CopyPlugin = require('copy-webpack-plugin');
+const package = require('./package.json');
 const path = require('path');
 
 module.exports = merge(common, {
     mode: 'production',
     plugins: [
         new CopyPlugin([
-            { from: path.join(__dirname, 'src', 'manifest.json'), to: 'manifest.json'}
+            {
+                from: path.join(__dirname, 'src', 'manifest.json'),
+                to: 'manifest.json',
+                transform(content) {
+                    return helpers.setManifestVersion(content, package.version)
+                }
+            }
         ])
     ]
 });

webpack.helpers.js

@@ -0,0 +1,10 @@
+module.exports = {
+    setManifestVersion: function(contents, version, version_name) {
+        let manifest = JSON.parse(contents);
+        manifest.version = version;
+        if (typeof version_name !== 'undefined') {
+            manifest.version_name = version_name;
+        }
+        return JSON.stringify(manifest);
+    }
+}