ci: website integrity checks (#288)

* ci: website integrity checks

* Apply suggestions from code review

Co-authored-by: Dimitri POSTOLOV <[email protected]>

* fix script

---------

Co-authored-by: Dimitri POSTOLOV <[email protected]>

Author: saihaj

.env.example

@@ -0,0 +1,4 @@
+ALGOLIA_API_KEY=
+ALGOLIA_APP_ID=
+NPM_TOKEN=
+SITE_URL=https://thegraph.com/docs

.github/workflows/website-integrity.yml

@@ -0,0 +1,44 @@
+name: Website Integrity
+on:
+  pull_request:
+    paths:
+      - 'pages/**'
+    branches:
+      - main
+jobs:
+  website-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Fetch
+        run: git fetch origin main
+
+      - name: Setup env
+        uses: the-guild-org/shared-config/setup@main
+        with:
+          nodeVersion: 18
+          packageManager: yarn
+
+      - name: Build Site
+        run: yarn build
+
+      - name: Compare
+        run: git diff origin/${{ github.base_ref }}.. -- route-lockfile.txt
+
+      - name: Diff to file
+        if: always()
+        id: diff_result
+        run: |
+          echo "result<<EOF" >> $GITHUB_OUTPUT
+          echo "$(git diff origin/${{ github.base_ref }}.. -- route-lockfile.txt)" >> $GITHUB_OUTPUT
+          echo EOF >> $GITHUB_OUTPUT
+
+      - name: Publish a message
+        if: always() && contains(steps.diff_result.outputs.result, 'diff')
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          message: |
+            ```diff
+            ${{ steps.diff_result.outputs.result }}
+            ```

.gitignore

@@ -38,3 +38,5 @@ yarn-error.log*
 *.tsbuildinfo
 
 .idea/
+
+public/sitemap*.xml

next-sitemap.config.cjs

@@ -0,0 +1,5 @@
+/** @type {import('next-sitemap').IConfig} */
+module.exports = {
+  siteUrl: process.env.SITE_URL || 'https://thegraph.com/docs/',
+  generateIndexSitemap: false,
+}

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "dev": "next dev",
     "build": "rm -rf .next && next build",
+    "postbuild": "next-sitemap --config next-sitemap.config.cjs && node scripts/sitemap-ci.mjs",
     "start": "next start",
     "export": "rm -rf out && next export -o out/docs",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.mjs && yarn prettier:check && yarn typecheck",
@@ -33,6 +34,7 @@
     "lodash": "^4.17.21",
     "next": "^12.3.4",
     "next-seo": "^5.15.0",
+    "next-sitemap": "^3.1.52",
     "prism-react-renderer": "^1.3.5",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
@@ -54,6 +56,7 @@
     "acorn": "^8.8.2",
     "acorn-jsx": "^5.3.2",
     "eslint": "^8.34.0",
+    "fast-xml-parser": "^4.1.2",
     "husky": "^8.0.3",
     "lint-staged": "^13.1.1",
     "path": "^0.12.7",