Merge branch 'main' into 41-feature-support-review-assignment-to-mult…

…iple-teams
zaphiro-technologies · Oct 10, 2023 · 0e9957b · 0e9957b
2 parents 85910ab + 291af36
commit 0e9957b
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 10 deletions.
diff --git a/.github/workflows/markdown.yaml b/.github/workflows/markdown.yaml
@@ -25,8 +25,37 @@ on:
         default: '.github/config/.markdownlint.json'
         required: false
         type: string
+      md-lint-globs:
+        required: false
+        type: string
+        default: |
+          **/*.md
+          **/*.MD
+          #.github
+          #vendor
 jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      files-changed: ${{ steps.filter.outputs.markdown }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          filters: |
+            markdown:
+              - '*.{md,MD}'
+              - '**/*.{md,MD}'
+              - '.github/config/.markdownlint.json'
+              - '.github/config/.prettierignore'
+              - '.github/config/md-link-config.json'
+              - '.github/config/spellcheck.yml'
+              - '.github/config/wordlist.txt'
+              - '.github/workflows/*.yaml'
   markdown:
+    needs: changes
+    if: ${{ needs.changes.outputs.files-changed == 'true' }}
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -37,7 +66,7 @@ jobs:
     - name: Prettify MD files
       uses: zaphiro-technologies/prettier_action@main
       with:
-          prettier_options: --ignore-path .github/config/.prettierignore --prose-wrap always --write **/*.{md,MD}
+          prettier_options: --prose-wrap always --write **/*.{md,MD}
           dry: true
           dry_no_fail: true
     - name: Lint
@@ -46,20 +75,14 @@ jobs:
       with:
         fix: true
         config: ${{ inputs.config-lint-path }}
-        globs: |
-          **/*.md
-          **/*.MD
+        globs: ${{ inputs.md-lint-globs || '**/*.{md,MD}' }}
     - name: Lint
       if: ${{ github.event_name != ' workflow_call' }}
       uses: DavidAnson/markdownlint-cli2-action@v11
       with:
         fix: true
         config: '.github/config/.markdownlint.json'
-        globs: |
-          **/*.md
-          **/*.MD
-          #.github
-          #vendor
+        globs: ${{ inputs.md-lint-globs || '**/*.{md,MD}' }}
     - name: Commit markdown-lint changes
       run: |
         git config --global user.name 'Bot'

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,11 +1,13 @@
 # github-workflows Release Notes
 
-## 0.0.2-dev - 2023-10-06
+## 0.0.2-dev - 2023-10-10
 
 ### Features
 
 - add-to-project workflow: set PR on creation to `🏗 In progress` and when ready
   to `🔖 Ready` (PR #50 by @chicco785)
+- markdown workflow: run jobs only when there are changes to markdown related
+  files (PR #52 by @chicco785)
 - markdown workflow: exclude `vendor` folder from links check (PR #47 by @tejo)
 - markdown workflow: exclude `vendor` folder from checks (PR #46 by @tejo)
 - add-to-project workflow: add support to assign multiple teams as reviewers