Merge pull request #320 from cf-convention/exclude-known-domains-that…

…-timeout

WIP: Exclude some domains from link checker

.github/workflows/check_links.yml

@@ -23,13 +23,34 @@ jobs:
         with:
           output: ./lychee/out.md
 
+        # See exclusions in .lycheeignore, remove lines and give it a
+        # whirl if you're hunting broken links
+      - name: Check links
+        id: lychee
+        uses: lycheeverse/lychee-action@master
+        with:
+          fail: true
+          # We need to exclude the cf-conventions-1.2 and .3 build dirs
+          # because they lead to an error of:
+          #   Error: Cannot read input content from file <relevant file>
+          #   Caused by:
+          #       stream did not contain valid UTF-8
+          # Note: --exclude-path only takes one input path, so we need
+          # to set it twice.
+          # Note also we define a .lycheeignore file to exclude some
+          # specific links for checking, instead of using --exclude.
+          args: >
+            --no-progress './*.md'
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
       - name: Upload report
-        if: ${{ always() }}
+        if: env.exit_code != 0
         uses: actions/upload-artifact@v1
         with:
           name: Link check report
           path: ./lychee/out.md
-      
+
       - name: Create Issue From File
         uses: peter-evans/[email protected]
         with:

.lycheeignore

@@ -0,0 +1,3 @@
+cfeditor.ceda.ac.uk
+wps-web1.ceda.ac.uk
+http://kitt.llnl.gov/trac/wiki/SatelliteData

constitution.md

@@ -100,4 +100,4 @@ The standard names committee will make proposals for modification of conventions
 
 The membership of the standard names committee should include representatives of the various scientific user communities of the CF standard.
 
-[code-of-conduct]: https://github.com/cf-convention/cf-conventions/blob/main/CODE_OF_CONDUCT.md
+[code-of-conduct]: https://github.com/cf-convention/cf-conventions/blob/main/CODE_OF_CONDUCT.md "Code of Conduct"