chore(release): publish [skip ci]

- @ohif/i18n@0.52.4 - @ohif/viewer@3.1.9
docs: stub environment variables docs
2019-12-16 15:13:14 +00:00 · 2019-12-16 09:47:12 -05:00 · 2019-12-16 09:41:41 -05:00
7 changed files with 56 additions and 11 deletions
@@ -72,12 +72,17 @@ module.exports = (env, argv, { SRC_DIR, DIST_DIR }) => {
    },
    plugins: [
      new webpack.DefinePlugin({
+        /* Application */
        'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
        'process.env.DEBUG': JSON.stringify(process.env.DEBUG),
        'process.env.APP_CONFIG': JSON.stringify(process.env.APP_CONFIG || ''),
        'process.env.PUBLIC_URL': JSON.stringify(process.env.PUBLIC_URL || '/'),
        'process.env.VERSION_NUMBER': JSON.stringify(PACKAGE.version || ''),
        'process.env.BUILD_NUM': JSON.stringify(BUILD_NUM),
+        /* i18n */
+        'process.env.USE_LOCIZE': JSON.stringify(process.env.USE_LOCIZE || ''),
+        'process.env.LOCIZE_PROJECTID': JSON.stringify(process.env.LOCIZE_PROJECTID || ''),
+        'process.env.LOCIZE_API_KEY': JSON.stringify(process.env.LOCIZE_API_KEY || ''),
      }),
    ],
    // Fix: https://github.com/webpack-contrib/css-loader/issues/447#issuecomment-285598881
@@ -0,0 +1,23 @@
+# Environment Variables
+
+There are a number of environment variables we use at build time to influence the output application's behavior.
+
+```bash
+# Application
+NODE_ENV=< production | development >
+DEBUG=< true | false >
+APP_CONFIG=< relative path to application configuration file >
+PUBLIC_URL=<>
+VERSION_NUMBER=<Set by CircleCI>
+BUILD_NUM=<Set by CircleCI>
+# i18n
+USE_LOCIZE=<false>
+LOCIZE_PROJECTID=<ProjectID to pull translations for>
+LOCIZE_API_KEY=<To enable Locize live editing of translations>
+```
+
+## Setting Environment Variables
+
+- `npx cross-env`
+- `.env` files
+- env variables on build machine, or for terminal session
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [0.52.4](https://github.com/OHIF/Viewers/compare/@ohif/i18n@0.52.3...@ohif/i18n@0.52.4) (2019-12-16)
+
+**Note:** Version bump only for package @ohif/i18n
+
+
+
+
+
 ## [0.52.3](https://github.com/OHIF/Viewers/compare/@ohif/i18n@0.52.2...@ohif/i18n@0.52.3) (2019-12-12)


@@ -1,6 +1,6 @@
 {
  "name": "@ohif/i18n",
-  "version": "0.52.3",
+  "version": "0.52.4",
  "description": "Internationalization library for The OHIF Viewer",
  "author": "OHIF",
  "license": "MIT",
@@ -29,19 +29,20 @@ function addLocales(newLocales) {
  customDebug(resourceBundle, 'info');
 }

-// Note: Developers can add the API key to use the in-context editor.
-// DO NOT commit the API key
-const config = (window.config && window.config.i18n) || {};
-
+/*
+ * Note: Developers can add the API key to use the
+ * in-context editor using environment variables.
+ * (DO NOT commit the API key)
+ */
 const locizeOptions = {
-  projectId: config.LOCIZE_PROJECTID,
-  apiKey: config.LOCIZE_API_KEY,
+  projectId: process.env.LOCIZE_PROJECTID,
+  apiKey: process.env.LOCIZE_API_KEY,
  referenceLng: 'en-US',
  fallbacklng: 'en-US',
 };

-const envUseLocize = !!config.USE_LOCIZE;
-const envApiKeyAvailable = !!config.LOCIZE_API_KEY;
+const envUseLocize = !!process.env.USE_LOCIZE;
+const envApiKeyAvailable = !!process.env.LOCIZE_API_KEY;
 const DEFAULT_LANGUAGE = 'en-US';

 function initI18n(
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [3.1.9](https://github.com/OHIF/Viewers/compare/@ohif/viewer@3.1.8...@ohif/viewer@3.1.9) (2019-12-16)
+
+**Note:** Version bump only for package @ohif/viewer
+
+
+
+
+
 ## [3.1.8](https://github.com/OHIF/Viewers/compare/@ohif/viewer@3.1.7...@ohif/viewer@3.1.8) (2019-12-16)

 **Note:** Version bump only for package @ohif/viewer
@@ -1,6 +1,6 @@
 {
  "name": "@ohif/viewer",
-  "version": "3.1.8",
+  "version": "3.1.9",
  "description": "OHIF Viewer",
  "author": "OHIF Contributors",
  "license": "MIT",
@@ -51,7 +51,7 @@
    "@ohif/extension-dicom-microscopy": "^0.50.6",
    "@ohif/extension-dicom-pdf": "^1.0.0",
    "@ohif/extension-vtk": "^1.1.4",
-    "@ohif/i18n": "^0.52.3",
+    "@ohif/i18n": "^0.52.4",
    "@ohif/ui": "^1.1.4",
    "@tanem/react-nprogress": "^1.1.25",
    "classnames": "^2.2.6",
Author	SHA1	Message	Date
ohif-bot	25599a2e2a	chore(release): publish [skip ci] - @ohif/i18n@0.52.4 - @ohif/viewer@3.1.9	2019-12-16 15:13:14 +00:00
Danny Brown	1cf7015511	docs: stub environment variables docs	2019-12-16 09:47:12 -05:00
Igor Octaviano	756f70cc54	refactor: 💡 Use env variables to set locize (#1299 ) Instead of relying in dynamic configuration, use dedicated env variables to set locize api key / configuration Closes: #1271	2019-12-16 09:41:41 -05:00