update

vbem · Sep 23, 2023 · ef3c4af · ef3c4af
1 parent cdc10a0
commit ef3c4af
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 18 deletions.
diff --git a/.github/workflows/linter-default.test.yml → .github/workflows/superlinter.test.yml b/.github/workflows/linter-default.test.yml → .github/workflows/superlinter.test.yml
@@ -1,5 +1,5 @@
 ---
-name: Test linter-default
+name: superlinter.test
 
 concurrency:
   group: ${{ github.workflow }}@${{ github.ref }}
@@ -12,5 +12,5 @@ on:
 
 jobs:
   calling:
-    uses: ./.github/workflows/linter-default.yml
+    uses: ./.github/workflows/superlinter.yml
 ...
diff --git a/.github/workflows/linter-default.yml → .github/workflows/superlinter.yml b/.github/workflows/linter-default.yml → .github/workflows/superlinter.yml
@@ -1,8 +1,8 @@
 ---
-name: Reusable Workflow - Super Linter - Default
+name: Reusable Workflow - superlinter
 
-on: # https://docs.github.com/en/actions/using-workflows/reusing-workflows
-  workflow_call:
+on:
+  workflow_call: # https://docs.github.com/en/actions/using-workflows/reusing-workflows
     inputs:
       timezone:
         description: 'The timezone, defaults to `Asia/Shanghai`'
@@ -19,7 +19,7 @@ env:
   TZ: ${{ inputs.timezone }}
 
 jobs:
-  linter-default:
+  superlinter:
     runs-on: ${{ fromJSON(inputs.runs-on) }}
 
     permissions:

diff --git a/README.md b/README.md
@@ -1,19 +1,14 @@
 # Yet another repository of reusable workflows
-[![Static Badge](https://img.shields.io/badge/GitHub%20Actions-reusable%20workflows-blue?logo=github)
-](https://docs.github.com/en/actions/using-workflows/reusing-workflows)
-[![GitHub](https://img.shields.io/github/license/vbem/reusable?color=blue
-)](LICENSE)
+[![Static Badge](https://img.shields.io/badge/GitHub%20Actions-reusable%20workflows-blue?logo=github)](https://docs.github.com/en/actions/using-workflows/reusing-workflows)
+[![GitHub](https://img.shields.io/github/license/vbem/reusable?color=blue)](LICENSE)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/vbem/reusable?label=Release&logo=github)](https://github.com/vbem/reusable/releases)
-[![Test linter-default](https://github.com/vbem/reusable/actions/workflows/linter-default.test.yml/badge.svg)](https://github.com/vbem/reusable/actions/workflows/linter-default.test.yml)
+[![superlinter.test](https://github.com/vbem/reusable/actions/workflows/superlinter.test.yml/badge.svg)](https://github.com/vbem/reusable/actions/workflows/superlinter.test.yml)
 
-## Linters
-A set of code-linter related [reusable workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows).
-
-### `linter-default`
-[`linter-default.yml`](.github/workflows/linter-default.yml) predefines some configurations for the well-known [*Super-Linter* action](https://github.com/marketplace/actions/super-linter). Create `.github/workflows/linter.yaml` in your repository:
+## `superlinter`
+[`superlinter.yml`](.github/workflows/superlinter.yml) predefines generic configurations for the well-known [*Super-Linter* action](https://github.com/marketplace/actions/super-linter). Create `.github/workflows/linter.yaml` in your repository:
 ```yaml
 ---
-name: Super Linter
+name: Linter
 
 concurrency:
   group: ${{ github.workflow }}@${{ github.ref }}
@@ -26,6 +21,6 @@ on:
 
 jobs:
   calling:
-    uses: vbem/reusable/.github/workflows/linter-default.yml@v1
+    uses: vbem/reusable/.github/workflows/superlinter.yml@v1
 ...
 ```