Merge remote-tracking branch 'origin/master' into clickable-legend-group-titles

Author: archmoj

.circleci/config.yml

@@ -15,25 +15,16 @@ jobs:
     steps:
       - checkout
       - run:
-          name: set heap option before very first node.js call
-          command: |
-            export NODE_OPTIONS='--max-old-space-size=4096'
-      - run:
-          name: Install dependencies
-          command: |
-            npm ci
-      - run:
-          name: List dependency versions
-          command: |
-            echo "npm: $(npm --version)"
-            echo "node: $(node --version)"
-            npm ls || true
+          name: Set up build environment
+          command: .circleci/env_build.sh
       - run:
           name: Pretest
-          command: |
-            npm run pretest
-            npm run cibuild
+          command: npm run pretest
+      - run:
+          name: CI-Build
+          command: npm run cibuild
       - run:
+          name: Delete git
           command: rm -rf .git
       - persist_to_workspace:
           root: /home/circleci
@@ -51,7 +42,7 @@ jobs:
           at: ~/
       - run:
           name: Run jasmine tests (part A)
-          command: ./.circleci/test.sh no-gl-jasmine
+          command: .circleci/test.sh no-gl-jasmine
 
   webgl-jasmine:
     docker:
@@ -64,9 +55,9 @@ jobs:
           at: ~/
       - run:
           name: Run jasmine tests (part B)
-          command: ./.circleci/test.sh webgl-jasmine
+          command: .circleci/test.sh webgl-jasmine
 
-  no-gl-flaky-jasmine:
+  flaky-no-gl-jasmine:
     docker:
       # need '-browsers' version to test in real (xvfb-wrapped) browsers
       - image: circleci/node:12.22.1-browsers
@@ -76,7 +67,7 @@ jobs:
           at: ~/
       - run:
           name: Run jasmine tests (part C)
-          command: ./.circleci/test.sh no-gl-flaky-jasmine
+          command: .circleci/test.sh flaky-no-gl-jasmine
 
   make-baselines:
     parallelism: 4
@@ -87,34 +78,11 @@ jobs:
       - attach_workspace:
           at: ~/
       - run:
-          name: which pip3 version
-          command: which pip3 && pip3 --version
+          name: Install kaleido, plotly.io and required fonts
+          command: .circleci/env_image.sh
       - run:
-          name: install kaleido v0.2.1
-          command: python3 -m pip install kaleido==0.2.1
-      - run:
-          name: install plotly.io v5.0.0
-          command: python3 -m pip install plotly==5.0.0
-      - run:
-          name: install liberation2 fonts
-          command: sudo apt-get install fonts-liberation2
-      - run:
-          name: install OpenSans fonts
-          command: sudo apt-get install fonts-open-sans
-      - run:
-          name: install NotoSansCJK fonts
-          command: sudo apt install fonts-noto-cjk
-      - run:
-          name: download google fonts e.g. Dosis, GravitasOne, NotoSansMono, NotoSans, NotoSerif, Old_Standard_TT, PT_Sans_Narrow, Raleway and Roboto
-          command: python3 ./.circleci/download_google_fonts.py
-      - run:
-          name: install downloaded google fonts
-          command: |
-            sudo cp -r .circleci/fonts/ /usr/share/
-            sudo fc-cache -f
-      - run:
-          name: create all png files
-          command: ./.circleci/test.sh make-baselines
+          name: Create all png files
+          command: .circleci/test.sh make-baselines
       - persist_to_workspace:
           root: ~/
           paths:
@@ -128,8 +96,8 @@ jobs:
       - attach_workspace:
           at: ~/
       - run:
-          name: compare pixels
-          command: ./.circleci/test.sh test-image ; find build -maxdepth 1 -type f -delete
+          name: Compare pixels
+          command: .circleci/test.sh test-image ; find build -maxdepth 1 -type f -delete
       - store_artifacts:
           path: build
           destination: /
@@ -142,19 +110,13 @@ jobs:
       - attach_workspace:
           at: ~/
       - run:
-          name: which pip3 version
-          command: which pip3 && pip3 --version
-      - run:
-          name: install kaleido v0.2.1
-          command: python3 -m pip install kaleido==0.2.1
+          name: Install kaleido, plotly.io and required fonts
+          command: .circleci/env_image.sh
       - run:
-          name: install plotly.io v5.0.0
-          command: python3 -m pip install plotly==5.0.0
-      - run:
-          name: install poppler-utils to have pdftops for exporting eps
+          name: Install poppler-utils to have pdftops for exporting eps
           command: sudo apt-get install poppler-utils
       - run:
-          name: create svg, jpg, jpeg, webp, pdf and eps files
+          name: Create svg, jpg, jpeg, webp, pdf and eps files
           command: python3 test/image/make_exports.py
       - persist_to_workspace:
           root: ~/
@@ -169,7 +131,7 @@ jobs:
       - attach_workspace:
           at: ~/
       - run:
-          name: test export sizes
+          name: Test export sizes
           command: node test/image/export_test.js ; find build -maxdepth 1 -type f -delete
       - store_artifacts:
           path: build
@@ -198,7 +160,7 @@ jobs:
           at: ~/
       - run:
           name: Run syntax tests on source files
-          command: ./.circleci/test.sh source-syntax
+          command: .circleci/test.sh source-syntax
 
   jasmine-bundle:
     docker:
@@ -210,26 +172,47 @@ jobs:
           at: ~/
       - run:
           name: Run jasmine tests (part D)
-          command: ./.circleci/test.sh jasmine-bundle
+          command: .circleci/test.sh jasmine-bundle
 
   publish-dist:
     docker:
       - image: circleci/node:12.22.1
     working_directory: ~/plotly.js
     steps:
-      - attach_workspace:
-          at: ~/
+      - checkout
+      - run:
+          name: Set up build environment
+          command: .circleci/env_build.sh
+      - run:
+          name: Preview CHANGELOG for next release (only on master)
+          command: |
+            if [ $CIRCLE_BRANCH == "master" ]
+              then npm run use-draftlogs && git --no-pager diff --color-words CHANGELOG.md || true
+            fi
+      - run:
+          name: Set draft version in package.json
+          command: |
+            node --eval "var fs = require('fs'); var inOut = './package.json'; var data = JSON.parse(fs.readFileSync(inOut)); var a = process.argv; data.version = a[a.length - 1].replace('v', ''); fs.writeFileSync(inOut, JSON.stringify(data, null, 2) + '\n');" `git describe`
+      - run:
+          name: View package.json diff between previous and next releases (including above draft version change)
+          command: git --no-pager diff --color-words tags/$(git describe --tags --abbrev=0) package.json || true
       - run:
           name: Build dist/
           command: npm run build
       - store_artifacts:
           path: dist
           destination: dist
+      - run:
+          name: Preview plot-schema diff between previous and next releases (only on master)
+          command: |
+            if [ $CIRCLE_BRANCH == "master" ]
+              then git --no-pager diff tags/$(git describe --tags --abbrev=0) dist/plot-schema.json || true
+            fi
       - run:
           name: Pack tarball
           command: |
             npm pack
-            version=$(node -e "console.log(require('./package.json').version)")
+            version=$(node --eval "console.log(require('./package.json').version)")
             mv plotly.js-$version.tgz plotly.js.tgz
       - store_artifacts:
           path: plotly.js.tgz
@@ -242,18 +225,9 @@ jobs:
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plotly.js
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plotly.min.js
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plot-schema.json
-      - persist_to_workspace:
-          root: ~/
-          paths:
-            - plotly.js
-
-  test-dist1:
-    docker:
-      - image: circleci/node:12.22.1
-    working_directory: ~/plotly.js
-    steps:
-      - attach_workspace:
-          at: ~/
+      - run:
+          name: Test plot-schema.json diff - If failed, after (npm start) you could run (npm run schema && git add test/plot-schema.json && git commit -m "update plot-schema diff")
+          command: diff --unified --color dist/plot-schema.json test/plot-schema.json
       - run:
           name: Test plotly.min.js import using requirejs
           command: npm run test-requirejs
@@ -263,20 +237,9 @@ jobs:
       - run:
           name: Test certain bundles against function constructors
           command: npm run no-new-func
-
-  test-dist2:
-    docker:
-      - image: circleci/node:12.22.1
-    working_directory: ~/plotly.js
-    steps:
-      - attach_workspace:
-          at: ~/
       - run:
           name: Test plotly bundles against es6
           command: npm run no-es6-dist
-      - run:
-          name: Test plotly bundles againt duplicate keys
-          command: npm run no-dup-keys
 
 workflows:
   version: 2
@@ -292,7 +255,7 @@ workflows:
       - webgl-jasmine:
           requires:
             - install-and-cibuild
-      - no-gl-flaky-jasmine:
+      - flaky-no-gl-jasmine:
           requires:
             - install-and-cibuild
       - make-baselines:
@@ -313,12 +276,5 @@ workflows:
       - source-syntax:
           requires:
             - install-and-cibuild
-      - publish-dist:
-          requires:
-            - install-and-cibuild
-      - test-dist1:
-          requires:
-            - publish-dist
-      - test-dist2:
-          requires:
-            - publish-dist
+
+      - publish-dist

.circleci/env_build.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+export NODE_OPTIONS='--max-old-space-size=4096' && \
+echo "node version: $(node --version)" && \
+echo "npm version: $(npm --version)" && \
+npm ci && \
+npm ls || true

.circleci/env_image.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+# install required fonts
+sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji && \
+sudo python3 .circleci/download_google_fonts.py && \
+sudo cp -r .circleci/fonts/ /usr/share/ && \
+sudo fc-cache -f && \
+# install kaleido & plotly
+sudo python3 -m pip install kaleido==0.2.1 plotly==5.1.0 --progress-bar off

.circleci/test.sh

@@ -63,7 +63,7 @@ case $1 in
         exit $EXIT_STATE
         ;;
 
-    no-gl-flaky-jasmine)
+    flaky-no-gl-jasmine)
         set_tz
 
         SHARDS=($(node $ROOT/tasks/shard_jasmine_tests.js --limit=1 --tag=flaky | circleci tests split))

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,11 +9,14 @@ Thanks for your interest in plotly.js!
 ### Features, Bug fixes, and others:
 
 Before opening a pull request, developer should:
+1. make sure they are not on the `master` branch of their fork as using `master` for a pull request would make it difficult to fetch `upstream` changes.
+2. fetch latest changes from `upstream/master` into your fork i.e. `origin/master` then pull `origin/master` from you local `master`.
+3. then `git rebase master` their local dev branch off the latest `master` which should be sync with `upstream/master` at this time.
+4. make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on version bumps).
+5. make sure to commit changes to the `package-lock.json` file (if any new dependency required).
+6. provide a title and write an overview of what the PR attempts to do with a link to the issue they are trying to address.
+7. select the _Allow edits from maintainers_ option (see this [article](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) for more details).
 
-- `git rebase` their local branch off the latest `master`,
-- make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on version bumps),
-- make sure to commit changes to the `package-lock.json` file (if any new dependency required),
-- write an overview of what the PR attempts to do,
-- select the _Allow edits from maintainers_ option (see this [article](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) for more details).
-
-Note that it is forbidden to force push (i.e. `git push -f`) to remote branches associated with opened pull requests. Force pushes make it hard for maintainers to keep track of updates. Therefore, if required, please `git merge master` into your PR branch instead of `git rebase master`.
+After opening a pull request, developer:
+ - should create a new small markdown log file using the PR number e.g. `1010_fix.md` or `1010_add.md` inside `draftlogs` folder as described in this [README](https://github.com/plotly/plotly.js/blob/master/draftlogs/README.md), commit it and push.
+ - should **not** force push (i.e. `git push -f`) to remote branches associated with opened pull requests. Force pushes make it hard for maintainers to keep track of updates. Therefore, if required, please fetch `upstream/master` and "merge" with master instead of "rebase".

CHANGELOG.md

@@ -9,6 +9,39 @@ To see all merged commits on the master branch that will be part of the next plo
 
 where X.Y.Z is the semver of most recent plotly.js release.
 
+## [2.2.1] -- 2021-07-06
+
+### Fixed
+ - Fix to improve sanitizing href inputs for SVG and HTML text elements [[#5803](https://github.com/plotly/plotly.js/pull/5803)]
+
+
+## [1.58.5] -- 2021-07-06
+
+### Fixed
+ - Fix to improve sanitizing href inputs for SVG and HTML text elements [[#5803](https://github.com/plotly/plotly.js/pull/5803)]
+
+
+## [2.2.0] -- 2021-06-28
+
+### Added
+ - Legend group titles [[#5752](https://github.com/plotly/plotly.js/pull/5752)],
+   this feature was anonymously sponsored: thank you to our sponsor!
+ - Add half-year directive (%h) for formatting dates and improve descriptions to include extra date formatting options [[#5762](https://github.com/plotly/plotly.js/pull/5762)],
+   this feature was anonymously sponsored: thank you to our sponsor!
+
+### Changed
+ - Modernize the process of creating baselines using [Kaleido](https://github.com/plotly/Kaleido) and improve image & other export test systems [[#5724](https://github.com/plotly/plotly.js/pull/5724)]
+ - Centralize jsdom utility to return Plotly object in node.js test scripts and use it in generating plot-schema [[#5755](https://github.com/plotly/plotly.js/pull/5755)]
+ - Bump turf bbox dependency to v6.4.0 [[#5747](https://github.com/plotly/plotly.js/pull/5747)]
+ - Bump turf area dependency to v6.4.0 [[#5748](https://github.com/plotly/plotly.js/pull/5748)]
+
+### Fixed
+ - Cache values and patterns in set_convert for axes with `rangebreaks` to improve performance [[#5659](https://github.com/plotly/plotly.js/pull/5659)],
+   with thanks to @spasovski for the contribution!
+ - Fix fetching geojson when ES6 import is used to load the library [[#5763](https://github.com/plotly/plotly.js/pull/5763)]
+ - Correct readme links [[#5746](https://github.com/plotly/plotly.js/pull/5746)]
+
+
 ## [2.1.0] -- 2021-06-18
 
 ### Added