chore: automate releases procedure

Author: saecki

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version_name:
+        description: 'User facing version name (eg: 0.3.0)'
+        type: string
+        required: true
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      RELEASE_VERSION: 'v${{ github.event.inputs.version_name }}'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Update docs
+        run: make release
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: 'chore: v${{ github.event.inputs.version_name  }} release'
+          tag: 'v${{ github.event.inputs.version_name }} --force'
+
+      - name: Create github release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: 'v${{ github.event.inputs.version_name }}'
+          body: ''
+          tag_name: 'v${{ github.event.inputs.version_name }}'
+          prerelease: false
+          draft: true

CONTRIBUTING.md

@@ -64,3 +64,11 @@ would be replaced by the generated default configuration, but
 is replaced by the contents of the `docgen/shared/keymaps.lua` file.\
 The indentation of the placeholder has to be a multiple of 4 spaces
 and will be applied to the replacement file.
+
+## Releases
+__Manual steps:__
+1. Update changelog and add migration guide
+2. Run github `Release` action and input new version
+2. Verify release
+  - Publish draft-release
+  - update `stable` tag

Makefile

@@ -10,3 +10,9 @@ test:
 doc:
 	nvim -l docgen/gen_doc.lua
 
+.PHONY: release
+release:
+	@test $${RELEASE_VERSION?Please set environment variable RELEASE_VERSION}
+	echo "${RELEASE_VERSION}" > docgen/shared/stable.txt
+	nvim -l docgen/gen_doc.lua
+	mv docgen/wiki/Documentation-unstable.md "docgen/wiki/Documentation-${RELEASE_VERSION}.md"

docgen/gen_doc.lua

@@ -5,7 +5,13 @@ exec nvim -l "$0" "$@"
 
 local config = require("lua.crates.config.init")
 local highlight = require("lua.crates.highlight")
-local version = "unstable"
+local version = vim.env["RELEASE_VERSION"] or "unstable"
+local stable_version = nil
+do
+    local file = io.open("docgen/shared/stable.txt")
+    stable_version = vim.trim(file:read("*a"))
+    file:close()
+end
 
 ---@param line_iter fun(): string?
 ---@param line string
@@ -399,6 +405,7 @@ local function gen_vim_doc()
         else
             ---@type string
             l = l:gsub("<VERSION>", version)
+            l = l:gsub("<STABLE>", stable_version)
             table.insert(lines, l)
         end
     end
@@ -433,6 +440,7 @@ local function gen_markdown(inpath, outpath)
             end
         else
             l = l:gsub("<VERSION>", version)
+            l = l:gsub("<STABLE>", stable_version)
             table.insert(lines, l)
         end
     end

docgen/shared/stable.txt

@@ -0,0 +1 @@
+v0.6.0

docgen/templates/README.md.in

@@ -69,7 +69,7 @@ lua require('crates').setup()
 </details>
 
 ## [Documentation](https://github.com/Saecki/crates.nvim/wiki)
-- [Stable](https://github.com/Saecki/crates.nvim/wiki/Documentation-v0.6.0)
+- [Stable](https://github.com/Saecki/crates.nvim/wiki/Documentation-<STABLE>)
 - [Unstable](https://github.com/Saecki/crates.nvim/wiki/Documentation-unstable)
 
 ## Related projects