Docs/docusaurus 3

.devcontainer/Dockerfile

@@ -0,0 +1,14 @@
+FROM mcr.microsoft.com/vscode/devcontainers/go:0-1.19
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+    pre-commit \
+    vim \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* \
+    && mkdir -p /go/pkg \
+    && chmod -R a+w /go/pkg
+
+WORKDIR /workspace

.devcontainer/devcontainer.json

@@ -0,0 +1,45 @@
+{
+  "name": "oauth2-proxy Dev",
+  "context": "..",
+  "dockerFile": "./Dockerfile",
+  "postCreateCommand": "pre-commit install && go mod download",
+  "containerEnv": { "DEVCONTAINER": "1" },
+  "appPort": ["4180:4180"],
+  "runArgs": ["-e", "GIT_EDITOR=code --wait"],
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "golang.go",
+        "ms-vscode.makefile-tools",
+        "visualstudioexptteam.vscodeintellicode",
+        "redhat.vscode-yaml",
+        "esbenp.prettier-vscode",
+        "GitHub.vscode-pull-request-github"
+      ],
+      "settings": {
+        "editor.formatOnPaste": false,
+        "editor.formatOnSave": true,
+        "editor.formatOnType": true,
+        "files.trimTrailingWhitespace": true,
+        "yaml.customTags": [
+          "!input scalar",
+          "!secret scalar",
+          "!include_dir_named scalar",
+          "!include_dir_list scalar",
+          "!include_dir_merge_list scalar",
+          "!include_dir_merge_named scalar"
+        ]
+      }
+    }
+  },
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker": {},
+    "ghcr.io/devcontainers/features/common-utils": {
+      "configureZshAsDefaultShell": true,
+      "username": "vscode",
+      "userUid": 1000,
+      "userGid": 1000
+    },
+    "ghcr.io/devcontainers/features/kubectl-helm-minikube": {}
+  }
+}

.github/renovate.json5

@@ -0,0 +1,24 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  semanticCommits: "auto",
+  enabledManagers: [
+    "dockerfile",
+    "gomod",
+    "github-actions",
+    "npm",
+    "regex",
+  ],
+  customManagers: [
+    {
+      customType: "regex",
+      fileMatch: [
+        "^Makefile"
+      ],
+      matchStrings: [
+        "DOCKER_BUILD_RUNTIME_IMAGE_ALPINE\\s+?\\?= alpine:(?<currentValue>.*)\\s"
+      ],
+      depNameTemplate: "alpine",
+      datasourceTemplate: "docker",
+    },
+  ],
+}

.github/workflows/create-release.yml

@@ -0,0 +1,117 @@
+name: Create Release
+run-name: Create release ${{ inputs.version }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version for new release'
+        required: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+      with:
+        ref: master
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Validate version
+      id: validate
+      run: |
+        function ver { printf "%03d%03d%03d%03d" $(echo "$1" | tr '.' ' '); }
+
+        NEW_VERSION=${{ inputs.version }}
+        NEW_VERSION=${NEW_VERSION#v} # Remove v prefix
+
+        LATEST_VERSION=$(git describe --abbrev=0 --tags)
+        LATEST_VERSION=${LATEST_VERSION#v} # Remove v prefix
+
+        # check that new version can be parsed
+        if [ ! $(ver $NEW_VERSION ) -gt $(ver 0) ]; then
+          echo "::error::Entered version '${{ inputs.version }}' cannot be parsed"
+          exit 1
+        fi
+
+        # check version continuity
+        if [ ! $(ver $LATEST_VERSION) -lt $(ver $NEW_VERSION) ]; then
+          echo "::error::Entered version '${{ inputs.version }}' is smaller then latest version $LATEST_VERSION"
+          exit 1
+        fi
+
+        echo "version=${NEW_VERSION}" >> "$GITHUB_OUTPUT"
+
+    - name: Prepare Github Actions Bot
+      run: |
+        git config --local user.name "github-actions[bot]"
+        git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+    - name: Setup node
+      uses: actions/setup-node@v3
+      with:
+        node-version: latest
+
+    - name: Update documentation
+      run: |
+        cd docs
+
+        FULL_VERSION=${{ steps.validate.outputs.version }}
+        VERSION=${FULL_VERSION%.*}.x
+
+        if [ ! -d "versioned_docs/version-${VERSION}" ]; then
+          npm ci
+          npm run docusaurus docs:version ${VERSION}
+
+          git add .
+          git commit -m "add new docs version ${VERSION}"
+        fi
+
+        sed -i "s/(current release is .*)/(current release is \`v${FULL_VERSION}\`)/g" docs/installation.md
+        sed -i "s/(current release is .*)/(current release is \`v${FULL_VERSION}\`)/g" versioned_docs/version-${VERSION}/installation.md
+
+    - name: Update Changelog
+      run: |
+        VERSION=${{ steps.validate.outputs.version }}
+
+        sed -i "s/#.*(Pre-release)/# V${VERSION}/g" CHANGELOG.md
+
+        cat << EOF > /tmp/CHANGELOG.prepend
+        # Vx.x.x (Pre-release)
+
+        ## Release Highlights
+
+        ## Important Notes
+
+        ## Breaking Changes
+        EOF
+
+        echo -e "$(cat /tmp/CHANGELOG.prepend)\n\n$(cat CHANGELOG.md)" > CHANGELOG.md
+
+    - name: Update development files
+      run: |
+        VERSION=${{ steps.validate.outputs.version }}
+        cd contrib
+        grep -rl "quay.io/oauth2-proxy/oauth2-proxy:" | \
+          xargs sed -i "s#quay.io/oauth2-proxy/oauth2-proxy:v[0-9]\+\.[0-9]\+\.[0-9]\+#quay.io/oauth2-proxy/oauth2-proxy:v${VERSION}#g"
+
+    - name: Commit and push
+      run: |
+        VERSION=${{ steps.validate.outputs.version }}
+
+        git checkout -b release/v${VERSION}
+        git commit -am "update to release version v${VERSION}"
+        git push -u origin release/v${VERSION}
+
+    - name: Create PR
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        VERSION=v${{ steps.validate.outputs.version }}
+        gh pr create -B master -H release/${VERSION} --title "release ${VERSION}" --body "Release branch and changes created by GitHub Actions. This PR should include changes to the docs, CHANGELOG and local environment files."

.github/workflows/docs.yaml

@@ -7,66 +7,62 @@ on:
   push:
     branches: [master]
     paths: ['docs/**']
+  workflow_dispatch:
 
 jobs:
   pull-request-check:
     if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          cache: npm
+          cache-dependency-path: "./docs/package-lock.json"
 
       - name: Test Build
         working-directory: ./docs
         run: |
           npm ci
           npm run build
 
-  gh-pages-release:
-    if: github.event_name == 'push'
+  build-docs:
+    if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
     steps:
       - uses: actions/checkout@v4
-        with:
-          path: master
-
-      - uses: actions/checkout@v4
-        with:
-          ref: gh-pages
-          path: gh-pages
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Build docusaurus
-        working-directory: master/docs
-        id: build
+        working-directory: ./docs
         run: |
-          echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
           npm ci
           npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build
 
-      - name: Release to github pages
-        env:
-          GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        working-directory: gh-pages
-        run: |
-          git config --local user.name "github-actions[bot]"
-          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
-
-          # Remove all files except .git
-          git rm -r *
-
-          # Copy the build files from master/docs/build to gh-pages
-          cp -r ../master/docs/build/* .
-
-          # Commit and push
-          git add .
-          git commit -m "Update documentation based on ${{ steps.build.outputs.sha }}"
-          git push origin gh-pages
+  deploy-docs:
+    needs: build-docs
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4