Merge pull request #2 from zentered/feat/include-exclude

feat: include and exclude paths, add toml support
zentered · Mar 15, 2021 · 70a4bfe · 70a4bfe
2 parents 860fdc7 + 8627777
commit 70a4bfe
Show file tree

Hide file tree

Showing 16 changed files with 4,550 additions and 191 deletions.
diff --git a/.github/workflows/seocheck.yml b/.github/workflows/seocheck.yml
@@ -13,6 +13,7 @@ jobs:
       - name: Markdown SEO Check
         uses: ./
         with:
+          includes: 'test/pass/*.md'
           max_title_length: 70
           max_description_length: 150
           max_slug_length: 100

diff --git a/README.md b/README.md
@@ -35,11 +35,13 @@ Validate markdown files with SEO best practices. Creates a pull request comment
 
 ## Inputs
 
-| Name                     | Requirement | Default | Description                   |
-| ------------------------ | ----------- | ------- | ----------------------------- |
-| `max_title_length`       | required    | 70      | Maximum length of page title  |
-| `max_description_length` | required    | 150     | Maximum length of description |
-| `max_slug_length`        | required    | 100     | Maximum length of slug        |
+| Name                     | Requirement | Default        | Description                                                                                                                             |
+| ------------------------ | ----------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| `includes`               | optional    | `{*.md,*.mdx}` | Glob to include specific files or folders. See [glob-to-regexp usage](https://www.npmjs.com/package/glob-to-regexp#usage) for examples. |
+| `excludes`               | optional    | ''             | Glob to exclude files or folders                                                                                                        |
+| `max_title_length`       | required    | 70             | Maximum length of page title                                                                                                            |
+| `max_description_length` | required    | 150            | Maximum length of description                                                                                                           |
+| `max_slug_length`        | required    | 100            | Maximum length of slug                                                                                                                  |
 
 ## Outputs
 

diff --git a/action.yml b/action.yml
@@ -3,6 +3,14 @@ branding:
   icon: check-square
 description: 'Check markdown files '
 inputs:
+  includes:
+    description: Glob to include specific files or folders
+    required: false
+    default: '{*.md,*.mdx}'
+  excludes:
+    description: Glob to exclude specific files or folders
+    required: false
+    default: ''
   max_title_length:
     description: 'Maximum length for page title'
     required: true