Merge pull request #82 from gary-kim/enh/noid/dev-version-indication

gary-kim · gary-kim · commit 6657d17990ce · 2020-01-04T12:03:59.000+08:00
Make version name indicate in-development versions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -92,8 +92,9 @@ For a new file, add this license header to the top of the file:
 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.
+6. Run `npm run libraries` to generate third-party library attributions.
+7. Run `npm run clean`, `SASPES_OFFICIAL_RELEASE=true 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.
+8. Run `npm run clean`, `SASPES_OFFICIAL_RELEASE=true 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
 ```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -35,6 +35,7 @@
     "ava": "^2.4.0",
     "babel-loader": "^8.0.6",
     "chromedriver": "^78.0.1",
+    "command-exists": "^1.2.8",
     "copy-webpack-plugin": "^5.1.1",
     "css-loader": "^3.4.0",
     "eslint": "^6.8.0",
diff --git a/src/.eslintrc.json b/src/.eslintrc.json
@@ -13,7 +13,8 @@
     "globals": {
         "Atomics": "readonly",
         "SharedArrayBuffer": "readonly",
-        "EXTENSION_VERSION_NAME": true
+        "SASPES_VERSION_NAME": true,
+        "SASPES_IS_OFFICIAL_RELEASE": true
     },
     "parserOptions": {
         "parser": "babel-eslint",
@@ -44,4 +45,4 @@
             "warn"
         ]
     }
-}
+}
diff --git a/src/js/components/ExtensionInfo.vue b/src/js/components/ExtensionInfo.vue
@@ -1,12 +1,12 @@
 <!--
  - @copyright Copyright (c) 2018-2019 Gary Kim <gary@garykim.dev>
- - 
+ -
  - @author Gary Kim <gary@garykim.dev>
- - 
+ -
  - SAS Powerschool Enhancement Suite - A browser extension to improve the experience of SAS Powerschool.
  -
  - This program is free software: you can redistribute it and/or modify
- - it under the terms of the GNU Affero General Public License as 
+ - it under the terms of the GNU Affero General Public License as
  - published by the Free Software Foundation, version 3.
  -
  - This program is distributed in the hope that it will be useful,
@@ -81,7 +81,7 @@ export default {
     data() {
         return {
             logo: browser.runtime.getURL("icons/128.png"),
-            version: EXTENSION_VERSION_NAME,
+            version: SASPES_VERSION_NAME,
             showInfo: false,
         };
     },
diff --git a/src/ui/options.html b/src/ui/options.html
@@ -1,18 +1,19 @@
 <!DOCTYPE html>
 <html>
 <head>
-    
+
 </head>
 <body>
-    <form>   
+    <h3>Version: <span id="version"></span></h3>
+    <form>
         <label><input type="checkbox" id="analytics" />Enable Analytics</label>
-        <br />   
+        <br />
         <label><input type="checkbox" id="percent-mp" />Load final percent on overall grade page</label>
         <br />
         <!--<label><input type="checkbox" id="save-grades" />Save last seen grades (requires previous option to work)</label>-->
     </form>
     <br />
-    
+
     <footer>
         <br />
         Last Seen Grades has been temporarily removed to be improved upon.<br />
diff --git a/src/ui/options.js b/src/ui/options.js
@@ -1,13 +1,13 @@
 /**
- * 
+ *
  * @copyright Copyright (c) 2018-2019 Gary Kim <gary@garykim.dev>
- * 
+ *
  * @author Gary Kim <gary@garykim.dev>
- * 
+ *
  * SAS Powerschool Enhancement Suite - A browser extension to improve the experience of SAS Powerschool.
  *
  * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as 
+ * it under the terms of the GNU Affero General Public License as
  * published by the Free Software Foundation, version 3.
  *
  * This program is distributed in the hope that it will be useful,
@@ -17,7 +17,7 @@
  *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- * 
+ *
  */
 
 'use strict';
@@ -37,6 +37,7 @@ function main() {
         analyticsid = returned.id;
     });
     document.getElementById("third-party-libraries").href = browser.extension.getURL("web_accessible_resources/libraries.txt");
+    document.getElementById("version").innerText = SASPES_VERSION_NAME;
     document.getElementById("analytics").addEventListener("click", function() {
         let value = document.getElementById("analytics").checked;
         if(!value)  {
diff --git a/tests/extensionInfo.js b/tests/extensionInfo.js
@@ -1,15 +1,15 @@
 /**
- * 
- * @copyright Copyright (c) 2019 Gary Kim <gary@garykim.dev>
- * 
+ *
+ * @copyright Copyright (c) 2019-2020 Gary Kim <gary@garykim.dev>
+ *
  * @author Gary Kim <gary@garykim.dev>
  *
  * @license GNU AGPL version 3
  *
  * SAS Powerschool Enhancement Suite - A browser extension to improve the experience of SAS Powerschool.
  *
  * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as 
+ * it under the terms of the GNU Affero General Public License as
  * published by the Free Software Foundation, version 3.
  *
  * This program is distributed in the hope that it will be useful,
@@ -19,10 +19,10 @@
  *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- * 
+ *
  */
 
-const package = require('../package.json');
+const version_name = require('../webpack-helpers').versionName();
 
 module.exports = {
     "Show Extension Info": browser => {
@@ -33,7 +33,7 @@ module.exports = {
     "Extension Version Correct": browser => {
         browser
             .assert.containsText('#saspes-info', 'SAS Powerschool Enhancement Suite')
-            .assert.containsText("#saspes-info", `Version: ${package.version_name}`)
+            .assert.containsText("#saspes-info", `Version: ${version_name}`)
     },
     "Extension Info Remember Open State": browser => {
         browser
diff --git a/webpack-helpers.js b/webpack-helpers.js
@@ -0,0 +1,23 @@
+const package = require('./package.json');
+const { execSync } = require('child_process');
+const commandExistsSync = require('command-exists').sync;
+
+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);
+    },
+    isRelease: function() {
+        return !!process.env.SASPES_OFFICIAL_RELEASE;
+    },
+    versionName: function () {
+        if (this.isRelease()) {
+            return package.version_name;
+        }
+        return package.version_name + " Development " + (commandExistsSync('git')? execSync('git describe --tags'): "(Exact Version Unknown)");
+    }
+}
diff --git a/webpack.chromium.js b/webpack.chromium.js
@@ -1,6 +1,6 @@
 const merge = require('webpack-merge');
 const common = require('./webpack.common.js');
-const helpers = require('./webpack.helpers.js');
+const helpers = require('./webpack-helpers.js');
 const CopyPlugin = require('copy-webpack-plugin');
 const package = require('./package.json');
 const path = require('path');
diff --git a/webpack.common.js b/webpack.common.js
@@ -1,8 +1,8 @@
 const path = require('path');
 const CopyPlugin = require('copy-webpack-plugin');
+const helpers = require('./webpack-helpers.js');
 const { VueLoaderPlugin } = require('vue-loader');
 const webpack = require('webpack');
-const package = require('./package.json');
 
 module.exports = {
     entry: {
@@ -42,7 +42,8 @@ module.exports = {
         ]),
         new VueLoaderPlugin(),
         new webpack.DefinePlugin({
-            "EXTENSION_VERSION_NAME": JSON.stringify(package.version_name)
+            "SASPES_VERSION_NAME": JSON.stringify(helpers.versionName()),
+            "SASPES_IS_OFFICIAL_RELEASE": helpers.isRelease(),
         })
     ],
     resolve: {
diff --git a/webpack.firefox.js b/webpack.firefox.js
@@ -1,6 +1,6 @@
 const merge = require('webpack-merge');
 const common = require('./webpack.common.js');
-const helpers = require('./webpack.helpers.js');
+const helpers = require('./webpack-helpers.js');
 const CopyPlugin = require('copy-webpack-plugin');
 const package = require('./package.json');
 const path = require('path');
diff --git a/webpack.helpers.js b/webpack.helpers.js
