ci: add test github workflows

* 👷 ci: add test github workflows

* ➕ chore: add temp build file

* 🐛 fix: fix user failOnWarnings param always be true

* 🐛 fix: fix warning about require from webpack

* ✅ test: add multiply base test case

Author: yuzhanglong

.github/workflows/multiply-base.yml

@@ -0,0 +1,20 @@
+name: Test Multiply Base
+
+on:
+  push:
+    branches:
+      - test-github-action
+
+jobs:
+  test-action-works:
+    runs-on: ubuntu-latest
+    name: test no config file
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: test multiply base
+        uses: ./
+        with:
+          files: './examples/no-config-file ./examples/only-warning'
+          failOnWarnings: true

.github/workflows/test-js-config.yml

@@ -0,0 +1,21 @@
+name: Test Js Config
+
+on:
+  push:
+    branches:
+      - test-github-action
+
+jobs:
+  test-action-works:
+    runs-on: ubuntu-latest
+    name: test js config
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: test js config
+        uses: ./
+        with:
+          files: './examples/js-config'
+          failOnWarnings: true
+          configFile: './examples/js-config/.lintmdrc.js'

.github/workflows/test-no-config-file.yml

@@ -0,0 +1,20 @@
+name: Test No Config File
+
+on:
+  push:
+    branches:
+      - test-github-action
+
+jobs:
+  test-action-works:
+    runs-on: ubuntu-latest
+    name: test no config file
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: test no config file
+        uses: ./
+        with:
+          files: './examples/no-config-file'
+          failOnWarnings: true

.github/workflows/test-only-warning.yml

@@ -0,0 +1,19 @@
+name: Test Only Warning
+
+on:
+  push:
+    branches:
+      - test-github-action
+jobs:
+  test-action-works:
+    runs-on: ubuntu-latest
+    name: test only warning
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: test only warning
+        uses: ./
+        with:
+          files: './examples/only-warning'
+          configFile: './examples/only-warning/.lintmdrc'

.github/workflows/test-use-config-file.yml

@@ -0,0 +1,20 @@
+name: Test Use Config File
+
+on:
+  push:
+    branches:
+      - test-github-action
+jobs:
+  test-action-works:
+    runs-on: ubuntu-latest
+    name: test use config file
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: test use config file
+        uses: ./
+        with:
+          files: './examples/use-config-file'
+          failOnWarnings: true
+          configFile: './examples/use-config-file/.lintmdrc'

.github/workflows/test-use-custom-config.yml

@@ -0,0 +1,20 @@
+name: Test Use Custom Config
+
+on:
+  push:
+    branches:
+      - test-github-action
+
+jobs:
+  test-action-works:
+    runs-on: ubuntu-latest
+    name: test use custom config
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: test use custom config
+        uses: ./
+        with:
+          files: './examples/use-custom-config'
+          failOnWarnings: true
+          configFile: './examples/use-custom-config/hello'

.github/workflows/test.yml

@@ -0,0 +1,15 @@
+name: Unit Test
+
+on: [ pull_request ]
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install modules
+        run: yarn install
+
+      - name: Run tests
+        run: yarn test

__tests__/github-action.spec.js

@@ -75,9 +75,9 @@ describe('lint-md GitHub action 测试', () => {
     expect(lintMdAction.isPass()).toStrictEqual(true)
   })
 
-  test('用户在 GitHub Action 将 failOnWarnings 值设为 true，本次 ci fail', async () => {
+  test('用户在 GitHub Action 将 failOnWarnings 值设为 true，即使只有 warning 本次 ci fail', async () => {
     process.env.GITHUB_WORKSPACE = path.resolve(process.cwd(), 'examples', 'only-warning')
-    mockAction(null, '.lintmdrc', true)
+    mockAction(null, '.lintmdrc', 'true')
     const lintMdAction = new LintMdAction()
     // lint
     await lintMdAction.lint()
@@ -86,10 +86,22 @@ describe('lint-md GitHub action 测试', () => {
 
   test('用户自定义的配置文件为 JavaScript 模块', async () => {
     process.env.GITHUB_WORKSPACE = path.resolve(process.cwd(), 'examples', 'js-config')
-    mockAction(null, '.lintmdrc.js', true)
+    mockAction(null, '.lintmdrc.js', 'true')
     const lintMdAction = new LintMdAction()
     // lint
     await lintMdAction.lint()
     expect(lintMdAction.isPass()).toStrictEqual(false)
   })
+
+  test('用户传入了多个以空格分割的检测目录', async () => {
+    process.env.GITHUB_WORKSPACE = path.resolve(process.cwd(), 'examples')
+    mockAction('./js-config ./no-config-file', null, 'true')
+    const lintMdAction = new LintMdAction()
+    // lint
+    await lintMdAction.lint()
+    lintMdAction.showResult()
+    lintMdAction.showErrorOrPassInfo()
+    const totalErrors = lintMdAction.getErrors()
+    expect(totalErrors.length).toStrictEqual(2)
+  })
 })

dist/index.js

@@ -35,7 +35,7 @@ class LintMdAction {
 
     // JavaScript 模块，直接 require
     if (configPath.endsWith('.js')) {
-      return require(configPath)
+      return require(`${configPath}`)
     }
     const content = fs.readFileSync(configPath).toString()
     return JSON.parse(content)
@@ -44,7 +44,8 @@ class LintMdAction {
   isPass() {
     const result = this.linter ? this.linter.errorCount() : {}
     const noErrorAndWarn = result.error === 0 && result.warning === 0
-    return core.getInput('failOnWarnings') ? noErrorAndWarn : result.error === 0
+    // 注意这里的 getInput 返回值为 string
+    return core.getInput('failOnWarnings') === 'true' ? noErrorAndWarn : result.error === 0
   }
 
   async lint() {