Setup Mike for versioning docs

Author: frankie567

.github/workflows/build.yml

@@ -2,14 +2,10 @@ name: Build documentation
 
 on:
   push:
+    tags:
+      - "*"
     branches:
-      - main
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
+      - master
 
 # Allow one concurrent deployment
 concurrency:
@@ -26,32 +22,23 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.12"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
-      - name: Set Posthog API key
+      - name: Parse tag
+        id: version_tag
+        uses: battila7/get-version-action@v2
+      - name: Deploy
+        env:
+          DOC_TAG: ${{ steps.version_tag.outputs.major && steps.version_tag.outputs.minor && format('{0}.{1} latest', steps.version_tag.outputs.major, steps.version_tag.outputs.minor) || 'dev' }}
         run: |
-          sed -i 's/__POSTHOG_API_KEY__/${{ secrets.POSTHOG_API_KEY }}/' overrides/partials/integrations/analytics/posthog.html
-      - name: Build
-        run: mkdocs build
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: ./site
-
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+          git config user.name fief-dev-ci
+          git config user.email ci@fief.dev
+          git fetch origin gh-pages --depth=1
+          hatch run mike deploy --push --update-aliases ${{ env.DOC_TAG }}

docs/assets/javascripts/posthog.js

@@ -49,6 +49,11 @@ repo_url: https://github.com/fief-dev/fief
 plugins:
   - search
   - tags
+  - mike
+
+extra:
+  version:
+    provider: mike
 
 markdown_extensions:
   - toc:
@@ -78,8 +83,6 @@ markdown_extensions:
   - footnotes
 
 extra:
-  analytics:
-    provider: posthog
   header_links:
     - title: About
       href: https://www.fief.dev
@@ -95,71 +98,71 @@ extra_javascript:
   - assets/javascripts/fernet.js
 
 watch:
-- examples
-- reusables
-- overrides
+  - examples
+  - reusables
+  - overrides
 
 nav:
   - index.md
   - Stronghold:
-    - stronghold/index.md
-  - 'Getting started':
-    - getting-started/introduction.md
-    - getting-started/local-instance.md
-    - getting-started/oauth2.md
-    - getting-started/try-oauth2.md
+      - stronghold/index.md
+  - "Getting started":
+      - getting-started/introduction.md
+      - getting-started/local-instance.md
+      - getting-started/oauth2.md
+      - getting-started/try-oauth2.md
   - user-journey.md
-  - 'Integrate':
-    - 'Python':
-      - 'General': integrate/python/index.md
-      - integrate/python/fastapi.md
-      - integrate/python/flask.md
-      - integrate/python/cli.md
-      - 'Reference ↗️': https://fief-dev.github.io/fief-python/
-    - 'JavaScript':
-      - 'General': integrate/javascript/index.md
-      - 'Backend':
-        - integrate/javascript/backend/express.md
-      - 'SSR':
-        - integrate/javascript/ssr/nextjs-app.md
-        - integrate/javascript/ssr/nextjs-pages.md
-      - 'Frontend':
-        - integrate/javascript/frontend/browser.md
-        - integrate/javascript/frontend/react.md
-      - 'Reference ↗️': https://fief-dev.github.io/fief-js/
-  - 'Configure':
-    - configure/index.md
-    - configure/tenants.md
-    - configure/clients.md
-    - configure/oauth-providers.md
-    - configure/users.md
-    - configure/user-fields.md
-    - configure/access-control.md
-    - configure/webhooks.md
-    - configure/api-keys.md
-    - 'Customization':
-        - configure/customization/themes.md
-        - configure/customization/email-templates.md
-  - 'Going further':
-    - going-further/authorize-url.md
-    - going-further/acr.md
-    - going-further/pkce.md
-    - going-further/id-token-encryption.md
-    - going-further/oauth-provider-token.md
-  - 'Admin API':
-    - api/index.md
-    - 'Webhooks':
-      - Integration guide: api/webhooks/guide.md
-      - Events: api/webhooks/events.md
-  - 'Self-hosting':
-    - self-hosting/index.md
-    - 'Deployment':
-      - self-hosting/deployment/railway.md
-      - self-hosting/deployment/render.md
-      - self-hosting/deployment/docker-compose.md
-    - 'Configuration':
-      - self-hosting/configuration/database.md
-      - self-hosting/configuration/email-provider.md
-      - self-hosting/configuration/ssl.md
-    - self-hosting/environment-variables.md
+  - "Integrate":
+      - "Python":
+          - "General": integrate/python/index.md
+          - integrate/python/fastapi.md
+          - integrate/python/flask.md
+          - integrate/python/cli.md
+          - "Reference ↗️": https://fief-dev.github.io/fief-python/
+      - "JavaScript":
+          - "General": integrate/javascript/index.md
+          - "Backend":
+              - integrate/javascript/backend/express.md
+          - "SSR":
+              - integrate/javascript/ssr/nextjs-app.md
+              - integrate/javascript/ssr/nextjs-pages.md
+          - "Frontend":
+              - integrate/javascript/frontend/browser.md
+              - integrate/javascript/frontend/react.md
+          - "Reference ↗️": https://fief-dev.github.io/fief-js/
+  - "Configure":
+      - configure/index.md
+      - configure/tenants.md
+      - configure/clients.md
+      - configure/oauth-providers.md
+      - configure/users.md
+      - configure/user-fields.md
+      - configure/access-control.md
+      - configure/webhooks.md
+      - configure/api-keys.md
+      - "Customization":
+          - configure/customization/themes.md
+          - configure/customization/email-templates.md
+  - "Going further":
+      - going-further/authorize-url.md
+      - going-further/acr.md
+      - going-further/pkce.md
+      - going-further/id-token-encryption.md
+      - going-further/oauth-provider-token.md
+  - "Admin API":
+      - api/index.md
+      - "Webhooks":
+          - Integration guide: api/webhooks/guide.md
+          - Events: api/webhooks/events.md
+  - "Self-hosting":
+      - self-hosting/index.md
+      - "Deployment":
+          - self-hosting/deployment/railway.md
+          - self-hosting/deployment/render.md
+          - self-hosting/deployment/docker-compose.md
+      - "Configuration":
+          - self-hosting/configuration/database.md
+          - self-hosting/configuration/email-provider.md
+          - self-hosting/configuration/ssl.md
+      - self-hosting/environment-variables.md
   - Telemetry: telemetry.md

mkdocs.yml

@@ -1 +1,2 @@
 mkdocs-material
+mike