Merge branch 'master' into fix-16924

Author: andrearoota

.eslintrc-common.yaml

@@ -39,7 +39,7 @@ rules:
                 - "error"
     prefer-const: 1
     no-constant-condition: 0
-    comma-dangle: 2
+    comma-dangle: 0
     no-debugger: 2
     no-dupe-keys: 2
     no-empty-character-class: 2
@@ -163,7 +163,7 @@ rules:
         - 2
         - "never"
     space-unary-ops: 2
-    spaced-comment: 0
+    spaced-comment: "error"
 
     max-nested-callbacks:
         - 1

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -41,10 +41,12 @@ body:
   attributes:
     label: Link to Minimal Reproduction
     description: |
-      If the reproduction does not need a build setup, please provide a link to [JSFiddle](https://jsfiddle.net/plainheart/e46ozpqj/7/), [JSBin](https://jsbin.com/) or [CodePen](https://codepen.io/Ovilia/pen/dyYWXWM). If it requires a build setup, you can use [CodeSandbox](https://codesandbox.io/s/echarts-basic-example-template-mpfz1s) or provide a GitHub repo.
+      If the reproduction does not need a build setup, please provide a link to [Official Editor](https://echarts.apache.org/examples/editor.html), [JSFiddle](https://jsfiddle.net/plainheart/e46ozpqj/7/), [JSBin](https://jsbin.com/) or [CodePen](https://codepen.io/Ovilia/pen/dyYWXWM). If it requires a build setup, you can use [CodeSandbox](https://codesandbox.io/s/echarts-basic-example-template-mpfz1s) or provide a GitHub repo.
+      The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed to show the bug.
+      Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided. [Why?](https://antfu.me/posts/why-reproductions-are-required)
 
   validations:
-    required: false
+    required: true
 
 - type: textarea
   attributes:

.github/pull_request_template.md

@@ -33,19 +33,28 @@ This pull request is in the type of:
 
 
 
-### After: How is it fixed in this PR?
+### After: How does it behave after the fixing?
 
 <!-- THE RESULT AFTER FIXING AND A SIMPLE EXPLANATION ABOUT HOW IT IS FIXED. -->
 
 <!-- ADD SCREENSHOT HERE IF APPLICABLE. -->
 
 
 
+## Document Info
+
+One of the following should be checked.
+
+- [ ] This PR doesn't relate to document changes
+- [ ] The document should be updated later
+- [ ] The document changes have been made in apache/echarts-doc#xxx
+
+
+
 ## Misc
 
-<!-- ADD RELATED ISSUE ID WHEN APPLICABLE -->
+### ZRender Changes
 
-- [ ] The API has been changed (apache/echarts-doc#xxx).
 - [ ] This PR depends on ZRender changes (ecomfe/zrender#xxx).
 
 ### Related test cases or examples to use the new APIs

.github/workflows/.scripts/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

.github/workflows/.scripts/update-notice-year.js

@@ -0,0 +1,93 @@
+/**
+ * @typedef {import('@octokit/rest').Octokit} Octokit
+ * @typedef {import('@actions/github')['context']} Context
+ */
+
+module.exports = async function updateNoticeYear(
+  /** @type {{ octokit: Octokit, context: Context }} */
+  { octokit, context }
+) {
+  const now = new Date()
+  // Change to UTC+8
+  now.setHours(now.getHours() + 8)
+  const newYear = now.getFullYear()
+  console.log('Prepare to update notice year to', newYear)
+
+  const noticeContent = `Apache ECharts
+Copyright 2017-${newYear} The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).`
+
+  const repoCtx = context.repo
+
+  const repoInfo = (await octokit.rest.repos.get(repoCtx)).data
+  const defaultBranchName = repoInfo.default_branch
+  const remoteNoticeFile = (await octokit.rest.repos.getContent({
+    ...repoCtx,
+    path: 'NOTICE',
+    ref: defaultBranchName
+  })).data
+  const remoteNoticeContent = base64ToUtf8(remoteNoticeFile.content)
+  if (remoteNoticeContent === noticeContent) {
+    console.log('NOTICE year is already updated.')
+    return
+  }
+
+  console.log('Ready to update the NOTICE file:\n' + noticeContent)
+
+  const defaultBranch = (await octokit.rest.repos.getBranch({
+    ...repoCtx,
+    branch: defaultBranchName
+  })).data
+
+  const newBranchName = `bot/update-notice-year/${newYear}`
+  await octokit.rest.git.createRef({
+    ...repoCtx,
+    ref: `refs/heads/${newBranchName}`,
+    sha: defaultBranch.commit.sha
+  })
+  console.log('Created a new branch:', newBranchName)
+
+  await octokit.rest.repos.createOrUpdateFileContents({
+    ...repoCtx,
+    path: 'NOTICE',
+    message: `chore: update NOTICE year to ${newYear}`,
+    content: utf8ToBase64(noticeContent),
+    sha: remoteNoticeFile.sha,
+    branch: newBranchName
+  })
+
+  console.log('Updated the NOTICE file on the new branch')
+
+  const pr = (await octokit.rest.pulls.create({
+    ...repoCtx,
+    head: newBranchName,
+    base: defaultBranchName,
+    maintainer_can_modify: true,
+    title: `chore: update NOTICE year to ${newYear}`,
+    body: `## Brief Information
+
+This pull request is in the type of:
+
+- [ ] bug fixing
+- [ ] new feature
+- [x] others
+
+### What does this PR do?
+
+Update notice year to ${newYear}. 💖
+
+Happy new year! 祝大家新年快乐！🎇`
+  })).data
+
+  console.log(`Opened PR #${pr.number} for updating the NOTICE file`)
+}
+
+function utf8ToBase64(data) {
+  return Buffer.from(data, 'utf-8').toString('base64')
+}
+
+function base64ToUtf8(data) {
+  return Buffer.from(data, 'base64').toString('utf-8')
+}

.github/workflows/ci.yml

@@ -2,15 +2,21 @@ name: Node CI
 
 on:
   pull_request:
-    types: [opened, synchronize]
+    types: [opened, reopened, synchronize]
+
+concurrency:
+  # Note that the `teardown-pr-preview` workflow needs the same group name
+  # to cancel the running `ci` workflows
+  group: ${{ github.workflow }}-${{ github.event.number }}
+  cancel-in-progress: true
 
 jobs:
   lint:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [18.x]
 
     steps:
       - name: Fetch commit count
@@ -19,18 +25,18 @@ jobs:
         run: |
           echo "FETCH_DEPTH=$(($PR_COMMIT_COUNT + 1))" >> $GITHUB_ENV
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: ${{ env.FETCH_DEPTH }}
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Cache node modules
         id: cache-dep
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: cache-node-modules
         with:
@@ -44,7 +50,7 @@ jobs:
       - name: Collect changed files
         run: |
           mkdir ~/tmp/
-          git diff ${{ github.event.pull_request.base.sha }} ${{ github.sha }} --name-only --relative '*src/**/*.ts' > ~/tmp/changed_files
+          git diff ${{ github.event.pull_request.base.sha }} ${{ github.sha }} --diff-filter=ACM --name-only --relative '*src/**/*.ts' > ~/tmp/changed_files
           echo -e "Changed files: \n$(cat ~/tmp/changed_files)"
 
       - name: Lint
@@ -58,19 +64,19 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Cache node modules
         id: cache-dep
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: cache-node-modules
         with:
@@ -81,11 +87,43 @@ jobs:
         if: steps.cache-dep.outputs.cache-hit != 'true'
         run: npm ci
 
+      - name: Unit Test
+        run: npm run test
+
       - name: Build release
         run: npm run release
 
       - name: Test generated DTS
         run: npm run test:dts
 
-      - name: Unit Test
-        run: npm run test
+      - name: Pack npm tarball
+        if: ${{ github.repository_owner == 'apache' }}
+        id: pack-tarball
+        run: |
+          export PR_PREVIEW_DIR='echarts-pr-preview'
+          mkdir -p $PR_PREVIEW_DIR
+          npm pack -pack-destination $PR_PREVIEW_DIR
+          echo "PR_PREVIEW_DIR=$PR_PREVIEW_DIR" >> $GITHUB_ENV
+
+      - name: Save PR metadata and dist files
+        if: ${{ steps.pack-tarball.outcome == 'success' }}
+        id: save-pr-data
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+          PR_COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
+          PR_PREVIEW_DIR: ${{ env.PR_PREVIEW_DIR }}
+        run: |
+          cd $PR_PREVIEW_DIR
+          echo $PR_NUMBER > ./pr_number
+          echo $PR_COMMIT_SHA > ./pr_commit_sha
+          find . -type f -regex ".*\.tgz" -exec tar xvzf {} \;
+          rm -f *.tgz
+          echo -e "Dist files: \n$(ls -l)"
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ steps.save-pr-data.outcome == 'success' }}
+        with:
+          name: pr_preview
+          path: ${{ env.PR_PREVIEW_DIR }}
+          retention-days: 1
+          if-no-files-found: error

.github/workflows/nightly-next.yml

@@ -2,7 +2,7 @@ name: Publish Nightly Next
 
 on:
   schedule:
-    - cron: '0 9 * * *' # After zrender nightly published
+    - cron: '10 9 * * *' # After zrender nightly published
   # committers can manually trigger with workflow_dispatch
   workflow_dispatch: {}
   repository_dispatch:
@@ -11,27 +11,33 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'apache' }}
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           ref: next
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           registry-url: https://registry.npmjs.org/
+          node-version: ${{ matrix.node-version }}
+
       - name: Setup and publish nightly
         run: |
+          node build/nightly/prepare.js --next
+          npm i zrender@npm:zrender-nightly@next
           npm ci
+          npm ls zrender
+          node build/nightly/post.js
           npm run release
           npm run test
           npm run test:dts
-          node build/prepareNightly.js --next
           npm publish --tag next
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.github/workflows/nightly.yml

@@ -11,24 +11,31 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'apache' }}
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           registry-url: https://registry.npmjs.org/
+          node-version: ${{ matrix.node-version }}
+
       - name: Setup and publish nightly
         run: |
+          node build/nightly/prepare.js
+          npm i zrender@npm:zrender-nightly
           npm ci
+          npm ls zrender
+          node build/nightly/post.js
           npm run release
           npm run test
           npm run test:dts
-          node build/prepareNightly.js
           npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}