Merge pull request #53 from codeplaysoftware/add-sitemap-generation

Add Sitemap Generation

Author: scottstraughan

.github/workflows/build.yml

@@ -39,6 +39,26 @@ jobs:
           name: routes
           path: routes.txt
 
+  # Generate a sitemap.xml and save to the src directory
+  generate-sitemap:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+      - name: Set up Python 3.11
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - name: Install Dependencies
+        run: pip install -r ./scripts/routes/requirements.txt --require-hashes --no-deps
+      - name: Create Sitemap
+        run: python ./scripts/routes/sitemap.py "$SITE_URL" "routes.txt" > src/sitemap.xml
+      - name: Upload to GitHub Artifacts
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b
+        with:
+          name: sitemap
+          path: sitemap.xml
+
   # Build the Angular site
   build:
     needs: generate-routes

angular.json

@@ -29,6 +29,7 @@
             "tsConfig": "tsconfig.app.json",
             "inlineStyleLanguage": "scss",
             "assets": [
+              "src/sitemap.xml",
               "src/404.html",
               "src/favicon.png",
               "src/robots.txt",

scripts/routes/sitemap.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+#
+#   Copyright (C) Codeplay Software Limited.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use these files except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   For your convenience, a copy of the License has been included in this
+#   repository.
+#
+#   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.
+#
+
+import os
+import sys
+
+
+def load_routes(routes_file_path: str):
+    with open(routes_file_path, mode='r', encoding='utf-8') as file:
+        return file.read().split(os.linesep)
+
+
+def generate(base_url: str, routes_file_path: str):
+    routes = load_routes(routes_file_path)
+    route_urls = [f'\t<url><loc>{base_url}{x}</loc></url>' for x in routes]
+
+    output = f"""<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+{os.linesep.join(route_urls)}
+</urlset>
+"""
+
+    return output
+
+
+if __name__ == '__main__':
+    args = sys.argv[1:]
+
+    try:
+        if len(args) != 2:
+            raise ValueError('Please provide a valid feed base URL and routes.txt file path.')
+
+        print(generate(args[0], args[1]))
+    except Exception as e:
+        print(str(e))
+        quit(1)

src/sitemap.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+	<url><loc>https://sycl.tech/</loc></url>
+	<url><loc>https://sycl.tech/getting-started</loc></url>
+	<url><loc>https://sycl.tech/getting-started/academy</loc></url>
+	<url><loc>https://sycl.tech/ecosystem</loc></url>
+	<url><loc>https://sycl.tech/ecosystem/projects</loc></url>
+	<url><loc>https://sycl.tech/ecosystem/presentations</loc></url>
+	<url><loc>https://sycl.tech/ecosystem/research</loc></url>
+	<url><loc>https://sycl.tech/ecosystem/implementations</loc></url>
+	<url><loc>https://sycl.tech/calendar</loc></url>
+	<url><loc>https://sycl.tech/news</loc></url>
+	<url><loc>https://sycl.tech/playground</loc></url>
+	<url><loc>https://sycl.tech/contributors</loc></url>
+	<url><loc>https://sycl.tech/settings</loc></url>
+	<url><loc>https://sycl.tech/privacy</loc></url>
+	<url><loc>https://sycl.tech/cookies</loc></url>
+	<url><loc>https://sycl.tech/404</loc></url>
+	<url><loc>https://sycl.tech</loc></url>
+</urlset>