Check functions catalog site for breakage on repo changes.

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "kpt-dev"
+  }
+}

.github/workflows/checkSite.yml

@@ -0,0 +1,42 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: CheckSite
+on:
+  pull_request:
+    paths:
+      - "functions/**"
+      - "examples/**"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/checkout@v2
+        with:
+          repository: etefera/href-checker
+          ref: docsify
+          path: href-checker
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - name: Install Site Checker
+        run: yarn install
+        working-directory: href-checker
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Run Site Checker
+        run: make site-check

Makefile

@@ -54,3 +54,11 @@ site-generate: ## Collect function branches and generate a catalog of their exam
 	rm -rf ./examples/*/
 	# GO111MODULE=on go get -v github.com/GoogleContainerTools/kpt@next
 	(cd scripts/generate_catalog/ && go run . ../.. ../../examples)
+
+site-run: ## Run the site locally.
+	make site-generate
+	./scripts/run-site.sh
+
+site-check: ## Test site for broken catalog links.
+	make site-run
+	./scripts/check-site.sh

examples/Dockerfile

@@ -0,0 +1,9 @@
+FROM nginx:1.18.0-alpine
+COPY . /usr/share/nginx/html
+COPY site_check.conf /etc/nginx/conf.d/configfile.template
+
+ENV PORT 80
+ENV HOST 0.0.0.0
+EXPOSE 80
+RUN sh -c "envsubst '\$PORT' < /etc/nginx/conf.d/configfile.template > /etc/nginx/conf.d/default.conf"
+CMD ["nginx", "-g", "daemon off;"]

examples/sidebar.md

@@ -0,0 +1,7 @@
+<!-- TODO: Generate this in a build step before deploying. -->
+- [Installation](https://kpt.dev/installation/)
+- [Book](https://kpt.dev/book/)
+- [Reference](https://kpt.dev/reference/)
+- [Functions Catalog](/)
+- [FAQ](https://kpt.dev/faq/)
+- [Contact](https://kpt.dev/contact/)

examples/site_check.conf

@@ -0,0 +1,21 @@
+server {
+    listen       $PORT;
+    server_name  localhost;
+    add_header Cache-Control 'no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0';
+
+    location ~* README.md$ {
+        root   /usr/share/nginx/html;
+        try_files $uri =404;
+    }
+
+    location / {
+        root   /usr/share/nginx/html;
+        index  index.html index.htm;
+        try_files $uri /index.html;
+    }
+
+    location ~* sidebar.md$ {
+        root   /usr/share/nginx/html;
+        index sidebar.md;
+    }
+}

firebase.json

@@ -0,0 +1,17 @@
+{
+  "hosting": {
+    "site": "kpt-functions-catalog",
+    "public": "examples",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ],
+    "rewrites": [
+      {
+        "source": "**",
+        "destination": "/index.html"
+      }
+    ]
+  }
+}

package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "href-checker": "etefera/href-checker"
+  }
+}

scripts/check-site.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o pipefail
+
+npm i
+cd examples || exit
+echo "Starting check."
+# Find all potential entrypoint READMEs
+# Convert them to valid URLs
+# Check each link for Docsify 404s
+find . -name README.md -printf "%P\n" | grep -v node_modules | sed "s/README.md//"  \
+    | sed "s/^/http:\/\/localhost:3001\//" \
+    | xargs -I {} -n1 sh -c "! (npx href-checker {} --bad-content=\"404 - Not found\" --silent --no-off-site -c=15 | grep .) || exit 255" 
+echo "Success."

scripts/generate_catalog/generate_catalog.go

@@ -181,7 +181,7 @@ func copyExamples(b string, funcName string, funcDest string, versionDest string
 	}
 
 	// Copy examples for the function's version to a temporary directory.
-	tempDir, err := os.MkdirTemp("", "examples")
+	tempDir, err := ioutil.TempDir("", "examples")
 	if err != nil {
 		return err
 	}
@@ -202,7 +202,7 @@ func copyExamples(b string, funcName string, funcDest string, versionDest string
 
 func copyReadme(b string, funcName string, relativeFuncPath string, versionDest string) error {
 	// Copy README for the function's version to the example directory.
-	tempDir, err := os.MkdirTemp("", "functions")
+	tempDir, err := ioutil.TempDir("", "functions")
 	if err != nil {
 		return err
 	}

scripts/run-site.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Set read/execute permissions for newly created site files in macOS or Linux.
+setfacl -Rd -m o::rx examples/ 2> /dev/null || chmod -R +a "everyone allow read,execute,file_inherit,directory_inherit" examples/
+# Set read/execute permissions for existing site files.
+chmod -R o+rx examples/
+# Terminate running kpt-function-catalog docker containers and rebuild.
+docker stop "$(docker ps -q --filter ancestor=kpt-function-catalog:latest)" || docker build examples/ -t kpt-function-catalog:latest
+# Mount the site directory as the default content for the docker container.
+docker run -v "$(pwd)"/examples:/usr/share/nginx/html -p 3001:80 -d kpt-function-catalog:latest
+echo "Serving docs at http://127.0.0.1:3001"