Merge pull request #21 from f-hollow/ci/add_pre_commit_hook

ci: Add pre-commit hook and link checker
espressif · May 28, 2024 · ec074db · ec074db
2 parents 25af5fb + 527c66a
commit ec074db
Show file tree

Hide file tree

Showing 27 changed files with 104 additions and 47 deletions.
diff --git a/.github/workflows/deploy-hugo-site.yml b/.github/workflows/deploy-hugo-site.yml
@@ -26,7 +26,21 @@ defaults:
     shell: bash
 
 jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v1
+        with:
+          args: --no-progress --include-fragments --exclude-path ./themes/ --exclude-path ./layouts/ .
+          # Fail action on broken links
+          fail: true
+
   build-and-deploy:
+    needs: check-links
     runs-on: ubuntu-latest
     steps:
 

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,20 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: local
+    hooks:
+      - id: lychee
+        name: lychee link checker
+        entry: lycheeverse/lychee
+        language: docker_image
+        types: [markdown]
+        args:
+          - "--no-progress"
+          - "--include-fragments"
diff --git a/README.md b/README.md
@@ -4,13 +4,40 @@ This project stores the files for the [Espressif Developer Portal][] website. Gi
 
 [Espressif Developer Portal]: https://developer.espressif.com/
 
+
+## Contribute and render locally
+
 If you want to contribute to this project, it would be nice to see the rendered version. The website can be easily rendered on your local machine using the following steps:
 
 1. Clone this repository using `git clone --recursive`.
 2. Install Hugo following the [instructions](https://gohugo.io/installation/).
-3. In the project folder, run `hugo server` and open the provided local web address, usually http://localhost:1313/.
+3. In the project folder, run `hugo server` and open the provided local web address, usually `http://localhost:1313/`.
 
 See also the Contribution Guide articles:
 
 - [Content contribution workflow](./content/pages/contribution_guide/content-contrib-workflow/index.md)
 - [Content writing workflow](./content/pages/contribution_guide/content-writing-workflow/index.md)
+
+
+## Use pre-commit
+
+This project has a [pre-commit][] hook that can perform the following checks:
+
+- Enforce coding standards and best practices in the project's codebase
+- Check links using [lychee][]
+  - **Important**: requires Docker
+  - `lychee` also runs as a GitHub action on pushes to main
+
+[pre-commit]: https://pre-commit.com/
+[lychee]: https://github.com/lycheeverse/lychee
+
+If you want to use pre-commit, in your project folder, run:
+
+```sh
+# Install requirements
+pip install -r requirements.txt
+# Set up git hook scripts
+pre-commit install
+# Remove git hook scripts (if not needed)
+pre-commit uninstall
+```
diff --git a/archetypes/default.md b/archetypes/default.md
@@ -3,4 +3,3 @@ title: "{{ replace .Name "-" " " | title }}"
 date: {{ .Date }}
 draft: true
 ---
-
diff --git a/assets/css/schemes/espressif.css b/assets/css/schemes/espressif.css
@@ -13,22 +13,22 @@
     --color-neutral-900:  18,  27,  33;
     /* Red */
     --color-primary-0:   252, 233, 232;
-    --color-primary-50:  250, 211, 209;   
-    --color-primary-100: 247, 189, 186; 
+    --color-primary-50:  250, 211, 209;
+    --color-primary-100: 247, 189, 186;
     --color-primary-150: 245, 167, 163;
-    --color-primary-200: 242, 145, 140; 
+    --color-primary-200: 242, 145, 140;
     --color-primary-250: 240, 123, 117;
-    --color-primary-300: 237, 101,  94; 
+    --color-primary-300: 237, 101,  94;
     --color-primary-350: 235,  80,  71;
-    --color-primary-400: 232,  58,  48; 
+    --color-primary-400: 232,  58,  48;
     --color-primary-450: 230,  36,  25;
-    --color-primary-500: 207,  32,  23; 
+    --color-primary-500: 207,  32,  23;
     --color-primary-550: 184,  29,  20;
-    --color-primary-600: 161,  25,  18; 
+    --color-primary-600: 161,  25,  18;
     --color-primary-650: 138,  21,  15;
-    --color-primary-700: 115,  18,  13; 
+    --color-primary-700: 115,  18,  13;
     --color-primary-750:  92,  14,  10;
-    --color-primary-800:  69,  11,   8; 
+    --color-primary-800:  69,  11,   8;
     --color-primary-850:  46,   7,   5;
     --color-primary-900:  23,   4,   3;
     --color-primary-950:   0,   0,   0;
@@ -44,10 +44,10 @@
     --color-secondary-800:  48,  36,  66;
     --color-secondary-900:  24,  18,  33;
   }
-  
-  /*   
+
+  /*
   #e7352c RED
   #674d8e Purple
   #384f7a Blue
   #2f4858 Grey
-  */
+  */
diff --git a/config/_default/languages.en.toml b/config/_default/languages.en.toml
@@ -26,5 +26,3 @@ title = "Developer Portal"
     { linkedin = "https://www.linkedin.com/company/espressif-systems/" },
     { github = "https://github.com/espressif" },
   ]
-
-
diff --git a/config/_default/params.toml b/config/_default/params.toml
@@ -76,8 +76,8 @@ smartTOCHideUnfocusedChildren = false
   showTableOfContents = true
   showRelatedContent = true
   relatedContentLimit = 3
-  showTaxonomies = true 
-  showAuthorsBadges = true 
+  showTaxonomies = true
+  showAuthorsBadges = true
   showWordCount = false
   sharingLinks = [ "linkedin", "twitter", "reddit", "whatsapp", "telegram", "facebook", "email"]
   showZenMode = true
@@ -121,7 +121,7 @@ smartTOCHideUnfocusedChildren = false
   groupByYear = false
   cardView = true
   cardViewScreenWidth = false
-  
+
 [firebase]
   apiKey = ""
   authDomain = ""

diff --git a/content/articles/_index.md b/content/articles/_index.md
@@ -9,7 +9,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : true
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/authors/_index.md b/content/authors/_index.md
@@ -8,7 +8,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/blog/_index.md b/content/blog/_index.md
@@ -10,7 +10,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : true
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/blog/giscus_test_post/index.md b/content/blog/giscus_test_post/index.md
@@ -18,8 +18,8 @@ Nunc tempus quis risus non vulputate. Praesent blandit sagittis massa posuere ve
 
 Mauris eleifend in augue a egestas. Donec eu ullamcorper mauris. Ut tristique elit vulputate ante suscipit, in ultrices lectus pretium. Cras sodales velit vitae massa ornare, eu imperdiet risus dictum. Etiam dui metus, feugiat vel hendrerit et, molestie a odio. Vivamus non fermentum nibh, ut cursus mi. Fusce sem sapien, ultricies eget purus et, efficitur sollicitudin erat. Etiam pharetra lacus urna, non pretium libero rutrum porta. Suspendisse aliquet nibh convallis nisi pulvinar molestie. Vivamus id arcu eu justo congue facilisis ut in urna. Donec ipsum nulla, rhoncus sit amet magna faucibus, consectetur fringilla turpis. Aliquam in egestas metus. Ut aliquet rhoncus libero ac fermentum. Pellentesque porta nisi mi, ac porta nisl congue et.
 
-Curabitur eu laoreet neque. Sed augue velit, ultrices nec ante eget, egestas posuere tortor. Vestibulum at nulla ullamcorper, ullamcorper neque sit amet, efficitur mi. Sed ornare leo erat, in ullamcorper tellus facilisis nec. Sed imperdiet ligula eu diam aliquam gravida. Sed pretium dictum erat eu porttitor. Donec pellentesque nisi sit amet ante sodales, eu bibendum mauris pretium. Aliquam molestie lacus nec nunc dictum ultrices. Interdum et malesuada fames ac ante ipsum primis in faucibus. Donec in maximus metus. Fusce mauris lectus, eleifend sed varius in, semper eu dolor. Quisque ut nisl pulvinar, scelerisque tellus vitae, convallis ex. Cras placerat quam et mi semper aliquam. Donec volutpat nulla est, eu suscipit augue rutrum sit amet. Vestibulum dapibus sem tortor, quis feugiat magna feugiat vel. Etiam ultrices iaculis lorem, vitae fermentum metus. 
+Curabitur eu laoreet neque. Sed augue velit, ultrices nec ante eget, egestas posuere tortor. Vestibulum at nulla ullamcorper, ullamcorper neque sit amet, efficitur mi. Sed ornare leo erat, in ullamcorper tellus facilisis nec. Sed imperdiet ligula eu diam aliquam gravida. Sed pretium dictum erat eu porttitor. Donec pellentesque nisi sit amet ante sodales, eu bibendum mauris pretium. Aliquam molestie lacus nec nunc dictum ultrices. Interdum et malesuada fames ac ante ipsum primis in faucibus. Donec in maximus metus. Fusce mauris lectus, eleifend sed varius in, semper eu dolor. Quisque ut nisl pulvinar, scelerisque tellus vitae, convallis ex. Cras placerat quam et mi semper aliquam. Donec volutpat nulla est, eu suscipit augue rutrum sit amet. Vestibulum dapibus sem tortor, quis feugiat magna feugiat vel. Etiam ultrices iaculis lorem, vitae fermentum metus.
 
 ## Conclusion
 
-This is a must have feature!
+This is a must have feature!
diff --git a/content/events/_index.md b/content/events/_index.md
@@ -9,7 +9,7 @@ showHeadingAnchors : false
 showPagination : true
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : true

diff --git a/content/pages/about.md b/content/pages/about.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/pages/arduino/index.md b/content/pages/arduino/index.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : true 
+showTaxonomies : true
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/pages/contribution_guide/content-contrib-workflow/index.md b/content/pages/contribution_guide/content-contrib-workflow/index.md
@@ -78,7 +78,7 @@ To contribute from the private mirror on Espressif GitLab to `espressif / develo
 
 For private contributions from anywhere, do the following:
 
-- Create a private mirror as described in [How to create a private mirror](#how-to-create-a-private-mirror)
+- Set up a private mirror as described in [How to set up a private mirror](#how-to-set-up-a-private-mirror)
 - In your private mirror, create a new branch and make the desired updates
 - Invite Espressif's reviewers to your private mirror to do the review
 - Once the private work on the new branch is finished, do the following in the private mirror:

diff --git a/content/pages/esp-idf/index.md b/content/pages/esp-idf/index.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : true 
+showTaxonomies : true
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/pages/ides/index.md b/content/pages/ides/index.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : true 
+showTaxonomies : true
 showWordCount : false
 showSummary : false
 sharingLinks : false
@@ -22,4 +22,3 @@ showRelatedContent : false
 relatedContentLimit : 3
 disableComments : true
 ---
-
diff --git a/content/pages/nuttx/index.md b/content/pages/nuttx/index.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : true 
+showTaxonomies : true
 showWordCount : false
 showSummary : false
 sharingLinks : false
@@ -22,4 +22,3 @@ showRelatedContent : false
 relatedContentLimit : 3
 disableComments : true
 ---
-
diff --git a/content/pages/rust/index.md b/content/pages/rust/index.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : true 
+showTaxonomies : true
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/pages/zephyr/index.md b/content/pages/zephyr/index.md
@@ -11,7 +11,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : true 
+showTaxonomies : true
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/tags/_index.md b/content/tags/_index.md
@@ -8,7 +8,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : false
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/content/tutorials/_index.md b/content/tutorials/_index.md
@@ -9,7 +9,7 @@ showHeadingAnchors : false
 showPagination : false
 showReadingTime : false
 showTableOfContents : true
-showTaxonomies : false 
+showTaxonomies : false
 showWordCount : false
 showSummary : false
 sharingLinks : false

diff --git a/data/authors/espressif.json b/data/authors/espressif.json
@@ -1,5 +1,5 @@
 {
-    "name": "John Lee", 
+    "name": "John Lee",
     "image" : "img/authors/espressif.png",
     "bio": "Espressif Systems",
     "social": [
@@ -10,4 +10,4 @@
         { "github": "https://github.com/espressif" },
         { "link": "https://espressif.com/"}
     ]
-}
+}
diff --git a/data/authors/pedrominatel.json b/data/authors/pedrominatel.json
@@ -6,4 +6,4 @@
         { "linkedin": "https://www.linkedin.com/in/pedrominatel/" },
         { "github": "https://github.com/pedrominatel" }
     ]
-}
+}
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
@@ -65,4 +65,4 @@
   {{ if templates.Exists "partials/extend-footer.html" }}
   {{ partialCached "extend-footer.html" . }}
   {{ end }}
-</footer>
+</footer>
diff --git a/layouts/partials/toc.html b/layouts/partials/toc.html
@@ -19,7 +19,7 @@
   </div>
 </details>
 
-{{ if .Site.Params.smartTOC }} 
+{{ if .Site.Params.smartTOC }}
 <script>
   (function () {
     var $toc = $('#TableOfContents');
@@ -36,30 +36,30 @@
             id = e.attr('id');
           }
         });
-        var active = $toc.find('a.active');      
+        var active = $toc.find('a.active');
         if (active.length == 1 && active.eq(0).attr('href') == '#' + id) return true;
 
         active.each(function (i, e) {
-          {{ if .Site.Params.smartTOCHideUnfocusedChildren }} 
+          {{ if .Site.Params.smartTOCHideUnfocusedChildren }}
             $(e).removeClass('active').siblings('ul').hide();
           {{ else }}
             $(e).removeClass('active');
           {{ end }}
         });
         $toc.find('a[href="#' + id + '"]').addClass('active')
         $toc.find('a[href="#' + id + '"]').parentsUntil('#TableOfContents').each(function (i, e) {
-          $(e).children('a').parents('ul').show();          
+          $(e).children('a').parents('ul').show();
         });
       }
 
       $window.on('scroll', onScroll);
       $(document).ready(function () {
-        {{ if .Site.Params.smartTOCHideUnfocusedChildren }} 
+        {{ if .Site.Params.smartTOCHideUnfocusedChildren }}
           $toc.find('a').parent('li').find('ul').hide();
         {{ end }}
         onScroll();
       });
     }
   })();
 </script>
-{{ end }}
+{{ end }}
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+pre-commit