merge master

.circleci/config.yml

@@ -13,7 +13,7 @@ jobs:
       - run:
           name: Install Node.js
           command: |
-            curl --silent --location https://rpm.nodesource.com/setup_10.x | sudo bash -
+            curl --silent --location https://rpm.nodesource.com/setup_12.x | sudo bash -
             sudo yum -y install nodejs
 
       - run:

.github/CODEOWNERS

@@ -2,5 +2,4 @@
 # https://help.github.com/articles/about-codeowners/
 #
 
-/docs/                                @lijiarui @hczhcz @TingYinHelen @ax4
-/examples/                            @Gcaufy @hczhcz
+/ @wechaty/contributors

.github/ISSUE_TEMPLATE/wechaty-bug-report.md

@@ -1,61 +1,73 @@
 ---
 name: Wechaty Bug Report
 about: Create a bug report for a bug you found in wechaty
-
 ---
 
-> Important：Please file the issue follow the template, or we won't help you to solve the problem.
-
+> Important：Please file the issue follow the template, or we won't be able to help you to solve the problem.
 
 ## 0. Report Issue Guide
 
 1. Please run the following command and check whether the problem has been fixed：
-```
-rm -rf package-lock.json
-rm -rf node_modules
-npm install
-```
 
-2. Please search in [FAQ List](https://docs.chatie.io/faq) first, and make sure your problem has not been solved before.
+    ```sh
+    rm -rf package-lock.json
+    rm -rf node_modules
+    npm install
+    ```
+
+2. Please search in [FAQ List](https://wechaty.js.org/faq) first, and make sure your problem has not been solved before.
 
 3. Please search in the issue first, and make sure your problem had not been reported before
 
 ## 1. Versions
-- What is your wechaty version?
+
+> What is your wechaty version?
+
 Answer:
 
-- Which puppet are you using for wechaty? (padchat/puppeteer/padpro/...)
+> Which puppet are you using for wechaty? (puppeteer/padlocal/service...)
+
 Answer:
 
-- What is your wechaty-puppet-XXX（padchat/puppeteer/） version?
+> What is your wechaty-puppet-XXX（padchat/puppeteer/） version?
+
 Answer:
 
-- What is your node version? (run `node --version`)
+> What is your node version? (run `node --version`)
+
 Answer:
 
-- What os are you using
+> What os are you using
+
 Answer:
 
 ## 2. Describe the bug
-Give a clear and concise description of what the bug is.
+
+> Give a clear and concise description of what the bug is.
 
 ## 3. To Reproduce
-This part is very important: if you can not provide any reproduce steps, then the problem will be very hard to be recognized.
+
+> This part is very important: if you can not provide any reproduce steps, then the problem will be very hard to be recognized.
+
+**[How to create a Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)**
 
 Steps to reproduce the behavior:
+
 1. run '...'
 2. ...
 3. ...
 
 ## 4. Expected behavior
-Give a clear and concise description of what you expected to happen.
+
+> Give a clear and concise description of what you expected to happen.
 
 ## 5. Actual behavior
-If applicable, add screenshots to help explain your problem. But do not paste log screenshots here.
 
+> If applicable, add screenshots to help explain your problem. But do not paste log screenshots here.
 
 ## 6. Full Output Logs
-Set env `WECHATY_LOG=silly` in order to set log level to silly, then we can get the full log (If you dosen't set log env, log level is info as default, we cannot get the full log)
+
+> Set env `WECHATY_LOG=silly` in order to set log level to silly, then we can get the full log (If you dosen't set log env, log level is info as default, we cannot get the full log)
 
 **We need full log instead of log screenshot or log fragments!**
 
@@ -67,14 +79,12 @@ Show Logs
 ```shell
 $ WECHATY_LOG=silly node yourbot.js
 
-Question: Paste your FULL(DO NOT ONLY PROVIDE FRAGMENTS) log messages
-Answer:
+-> PASTE YOUR FULL(DO NOT ONLY PROVIDE FRAGMENTS) LOG MESSAGES HERE
 
 ```
 
 </details>
 
 ## 7. Additional context
-Add any other context about the problem here.
 
-[bug]
+> Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,32 +1,12 @@
-## I'm submitting a...
-
-```
-[ ] Bug Fix
-[ ] Feature
-[ ] Other (Refactoring, Added tests, Documentation, ...)
-```
-
 ## Checklist
 
 - [ ] Commit Messages follow the [Conventional Commits](https://conventionalcommits.org/) pattern
   - A feature commit message is prefixed "feat:"
   - A bugfix commit message is prefixed "fix:"
 - [ ] Tests for the changes have been added
-
+- [ ] CI has been passed. (GitHub actions all turns green)
+- [ ] SLA has been signed
 
 ## Description
 
-_please describe the changes that you are making_
-
-_for features, please describe how to use the new feature_
-
-_please include a reference to an existing issue, if applicable_
-
-
-## Does this PR introduce a breaking change?
-
-```
-[ ] Yes
-[ ] No
-```
-
+> please describe the changes that you are making, with the related issue number.

.github/workflows/docker.yml

@@ -21,23 +21,17 @@ jobs:
       - run: ./scripts/docker.sh build
       - run: ./scripts/docker.sh test
 
+  # https://www.prestonlamb.com/blog/creating-a-docker-image-with-github-actions
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v'))
     name: Publish
     needs: [build]
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v'))
     runs-on: ubuntu-latest
     steps:
-      - name: Check Branch
-        id: check-branch
-        run: |
-          if [[ ${{ github.ref }} =~ ^refs/heads/(master|v[0-9]+\.[0-9]+.*)$ ]]; then
-              echo ::set-output name=match::true
-          fi  # See: https://stackoverflow.com/a/58869470/1123955
-      - name: Is A Publish Branch
-        if: steps.check-branch.outputs.match == 'true'
-        run: curl -X POST -d '{"from":"GitHub Action"}' "$DOCKER_REBUILD_URL"
-        env:
-          DOCKER_REBUILD_URL: ${{ secrets.DOCKER_REBUILD_URL }}
-      - name: Is Not A Publish Branch
-        if: steps.check-branch.outputs.match != 'true'
-        run: echo 'Not A Publish Branch'
+      - uses: actions/checkout@v2
+      - name: Build the Docker image
+        run: ./scripts/docker.sh build
+      - name: Login to DockerHub Registry
+        run: echo ${{ secrets.DOCKER_PERSONAL_ACCESS_TOKEN }} | docker login -u zixia --password-stdin
+      - name: Deploy to Docker Hub
+        run: ./scripts/docker.sh deploy

.github/workflows/node.js.yml

@@ -0,0 +1,37 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        node-version: [14]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v2
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+        restore-keys: |
+          ${{ runner.os }}-wechaty-
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm run build --if-present
+    - run: npm test
+      env:
+        CI: true

.github/workflows/npm.yml

@@ -5,19 +5,20 @@ on: [push, pull_request]
 jobs:
   build:
     name: Build
-    strategy:
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-        node: [12, 13]
-
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+      - uses: actions/cache@v2
         with:
-          node-version: ${{ matrix.node-version }}
+          path: ~/.npm
+          key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-wechaty-
 
+      - name: Use Node.js 15
+        uses: actions/setup-node@v2
+        with:
+          node-version: 15
       - name: Install Dependencies
         run: npm install
 
@@ -30,9 +31,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-wechaty-
+
+      - uses: actions/setup-node@v2
         with:
-          node-version: 13
+          node-version: 15
       - run: npm install
       - run: ./scripts/generate-version.sh
       - run: ./scripts/npm-pack-testing.sh
@@ -46,9 +54,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-wechaty-
+
+      - uses: actions/setup-node@v2
         with:
-          node-version: 13
+          node-version: 15
           registry-url: https://registry.npmjs.org/
       - run: npm install
       - run: ./scripts/generate-version.sh
@@ -63,9 +78,15 @@ jobs:
           fi  # See: https://stackoverflow.com/a/58869470/1123955
       - name: Is A Publish Branch
         if: steps.check-branch.outputs.match == 'true'
-        run: npm publish
+        run: |
+          NAME=$(npx pkg-jq -r .name)
+          VERSION=$(npx pkg-jq -r .version)
+          if npx version-exists "$NAME" "$VERSION"
+          then echo "$NAME@$VERSION exists on NPM, skipped."
+          else npm publish
+          fi
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Is Not A Publish Branch
         if: steps.check-branch.outputs.match != 'true'
         run: echo 'Not A Publish Branch'

.gitignore

@@ -57,7 +57,7 @@ yarn.lock
 .yarn-cache/
 .v8flags.*
 
-# why? forgot... 2017-05-18 by zixia
+# why? forgot... 2017-05-18 by huan
 /tests/fixtures/docker/package.json
 
 tags

.npmignore

@@ -0,0 +1 @@
+docs/

.nycrc

@@ -0,0 +1,3 @@
+{
+    "reporter": ["lcov", "text-summary"]
+}

.vscode/settings.json

@@ -70,4 +70,30 @@
     "javascript",
     "typescript",
   ],
+  "cSpell.words": [
+    "Gitter",
+    "Wechaty",
+    "appid",
+    "botie",
+    "huan",
+    "ioscat",
+    "ipad",
+    "lcov",
+    "lijiarui",
+    "logonoff",
+    "padchat",
+    "padplus",
+    "padpro",
+    "pagepath",
+    "portfinder",
+    "qrcode",
+    "removee",
+    "ruirui",
+    "thumbnailurl",
+    "wechat",
+    "weixin",
+    "wxwork",
+    "zbeekman",
+    "zixia"
+  ],
 }

AUTHORS

@@ -1,2 +1,2 @@
-Huan  <zixia@zixia.net>       https://github.com/zixia
+Huan  <zixia@zixia.net>       https://github.com/huan
 Rui   <ruiruibupt@gmail.com>  https://github.com/lijiarui