Add broken link checker

Author: ccfontes

.github/workflows/broken-link-checker.yml

@@ -0,0 +1,24 @@
+name: Doc links
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+
+jobs:
+  link_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Asciidoc-link-checker
+        run: npm install -g asciidoc-link-check
+      - name: Run asciidoc-link-check
+        run: |
+          git clone https://github.com/${{ github.repository_owner }}/faas-bb.git
+          cd faas-bb
+          git checkout ${{ github.head_ref || github.ref_name }}
+          find . -name '*.adoc' -exec sh -c 'asciidoc-link-check -p "{}" || echo "error"' \; | grep -q "error" && exit 1 || exit 0

.github/workflows/faas_fn_build_invoke.yml

@@ -29,8 +29,9 @@ jobs:
           DOCKER_REGISTRY_IMG_ORG_PATH: ghcr.io/${{ github.repository_owner }}
         run: |
           git clone https://github.com/${{ github.repository_owner }}/faas-bb.git
-          cd faas-bb/examples
+          cd faas-bb
           git checkout ${{ github.head_ref || github.ref_name }}
+          cd examples
           faas template pull https://github.com/${{ github.repository_owner }}/faas-bb#${{ github.head_ref || github.ref_name }}
           faas build
           if [ "$(echo world | docker run -i ghcr.io/${{ github.repository_owner }}/bb-hello:latest ./index.clj)" != "Hello, world" ]; then

README.adoc

@@ -2,16 +2,19 @@
 :img-ci-tests-status: {url-proj}/actions/workflows/faas_fn_build_invoke.yml/badge.svg
 :img-ci-hadolint-status: {url-proj}/actions/workflows/hadolint.yml/badge.svg
 :img-ci-clj-kondo-status: {url-proj}/actions/workflows/clj-kondo.yml/badge.svg
+:img-ci-lychee-link-check-status: {url-proj}/actions/workflows/broken-link-checker.yml/badge.svg
 :url-ci-status-tests: "{url-proj}/actions/workflows/faas_fn_build_invoke.yml"
 :url-ci-status-hadolint: "{url-proj}/actions/workflows/hadolint.yml"
 :url-ci-status-clj-kondo: "{url-proj}/actions/workflows/clj-kondo.yml"
+:url-ci-status-lychee-link: "{url-proj}/actions/workflows/broken-link-checker.yml"
 :img-license: https://img.shields.io/badge/license-MIT-black.svg
 
 = OpenFaaS Babashka template =
 
 image:{img-ci-tests-status}[link={url-ci-status-tests}]
 image:{img-ci-hadolint-status}[link={url-ci-status-hadolint}]
 image:{img-ci-clj-kondo-status}[link={url-ci-status-clj-kondo}]
+image:{img-ci-lychee-link-check-status}[link={url-ci-status-lychee-link}]
 image:{img-license}[link=LICENSE]
 
 An https://github.com/openfaas[OpenFaaS] template for writing Functions in https://github.com/babashka/babashka[Babashka].
@@ -47,7 +50,7 @@ A new project is created for a function defined as `my-bb-function`. It will con
 
 OpenFaaS watchdog is `of-watchdog` in https://github.com/openfaas/of-watchdog#3-streaming-fork-modestreaming---default[Streaming fork] mode.
 
-== link:function-examples[Function examples] ==
+== link:examples[Function examples] ==
 
 See the link:examples[examples] directory to find a fully working set of OpenFaaS Functions written in Babashka.