Just publish release branches

.github/workflows/ci.yaml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       - master
-      - release/*
+      - release/2*
   pull_request:
   workflow_dispatch:
     inputs:
@@ -27,8 +27,11 @@ jobs:
           persist-credentials: false
           fetch-depth: 0
 
+      - name: Setup Just
+        uses: extractions/setup-just@v2
+
       - name: Build docs
-        run: make build
+        run: just build
 
       - name: Deploy preview to Netlify
         uses: nwtgck/actions-netlify@v2
@@ -46,13 +49,13 @@ jobs:
           NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
         timeout-minutes: 5
 
-      - name: Build versioned docs
-        # TODO support publishing non-dev versions
-        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+      - name: Publish versioned docs
+        if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release/2'))
         env:
           PUSH_TOKEN: ${{ secrets.GH_DEPLOY_PUSH_TOKEN }}
         run: |
-          make deploy RELEASE=dev ALIAS=master
+          just deploy
+          just list
           git push https://[email protected]/${{ github.repository }} publish
 
       - name: Setup tmate session for debug

Justfile

@@ -0,0 +1,41 @@
+set shell := ["bash", "-euo", "pipefail", "-c"]
+
+[private]
+@default: build
+
+export DOCKER_CLI_HINTS := "false"
+
+image_name := "ghcr.io/githedgehog/hhdocs"
+image_version := "20241202"
+image := image_name + ":" + image_version
+
+# Run mkdocs or mike CLI in a container
+_run +cmd:
+  docker run -q --pull=always --rm -v $(pwd):/docs -p 8000:8000 {{image}} {{cmd}}
+
+# Build docs site (unversioned)
+build: (_run "mkdocs build")
+
+# Clean generated docs site
+clean:
+  rm -rf site
+
+# Serve docs site (unversioned, watches for changes)
+serve: (_run "mkdocs serve -a 0.0.0.0:8000")
+
+# List published versions
+list: (_run "mike list -b publish")
+
+branch_current := `git branch --show-current --format "%(refname:short)"`
+branch_latest := `git branch --list 'release/2*' --format "%(refname:short)" --sort=-version:refname | head -n 1`
+release := trim_start_match(branch_current, "release/")
+
+_release := if branch_current == "master" { "dev" } else { release }
+_alias := if branch_current == branch_latest { "latest" } else if branch_current == "master" { "master" } else { "" }
+
+# Shoud version that will be deployed (to publish branch)
+@version:
+  echo "Release '{{_release}}' alias '{{_alias}}'"
+
+# Deploy docs site (versioned) to publish branch
+deploy release=_release alias=_alias: (_run "mike deploy -b publish -u" release alias)

docs/contribute/docs.md

@@ -7,15 +7,15 @@ This documentation is done using [MkDocs](https://www.mkdocs.org) with multiple
 In order to contribute to the documentation, you'll need to have Git and Docker installed on your machine as well as any editor of your choice, preferably supporting Markdown preview. You can run the preview server using following command:
 
 ``` bash
-make serve
+just serve
 ```
 
 Now you can open continuously updated preview of your edits in browser at [http://127.0.0.1:8000](http://127.0.0.1:8000). Pages will be automatically updated while you're editing.
 
 Additionally you can run
 
 ```bash
-make build
+just build
 ```
 
 to make sure that your changes will be built correctly and doesn't break documentation.