.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Run cake
         uses: coactions/setup-xvfb@v1
         with:
-          run: dotnet cake --target Publish --ref ${{ github.ref }} --buildNum ${{ github.run_number }}
+          run: dotnet cake --target Publish --branch ${{ github.ref_name }}
         env:
           NUGET_KEY: ${{ secrets.NUGET_KEY }}
           BAGET_KEY: ${{ secrets.BAGET_KEY }}
@@ -41,9 +41,9 @@ jobs:
       - name: Restore tools
         run: dotnet tool restore
       - name: Run cake
-        run: dotnet cake --target Document --ref ${{ github.ref }} --buildNum ${{ github.run_number }}
+        run: dotnet cake --target Document --branch $GITHUB_REF_NAME
       - name: Deploy
-        if: startsWith(github.ref, 'refs/tags/')
+        if: github.event_name == 'push' && github.ref_name == 'release'
         # this is a beautiful way to deploy a website and i will not take any criticism
         run: |
           curl -L --output cloudflared.deb https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64.deb && sudo dpkg -i cloudflared.deb

CHANGELOG.md

@@ -2,8 +2,7 @@
 MLEM tries to adhere to [semantic versioning](https://semver.org/). Potentially breaking changes are written in **bold**.
 
 Jump to version:
-- [6.3.2](#632-in-development)
-- [6.3.1](#631)
+- [6.3.1](#631-in-development)
 - [6.3.0](#630)
 - [6.2.0](#620)
 - [6.1.0](#610)
@@ -13,11 +12,7 @@ Jump to version:
 - [5.1.0](#510)
 - [5.0.0](#500)
 
-## 6.3.2 (In Development)
-
-## 6.3.1
-
-No code changes
+## 6.3.1 (In Development)
 
 ## 6.3.0
 

Docs/overrides/conceptual.extension.js

@@ -1,5 +1,8 @@
 exports.preTransform = function (model) {
     if (model._path.includes("index")) {
+        // point to the release branch in the readme
+        model.conceptual = model.conceptual.replaceAll(/\/MLEM(\/[^/]+)?\/main\//g, "/MLEM$1/release/");
+
         // reduce header levels by 1 to allow for TOC navigation
         for (let i = 5; i >= 1; i--)
             model.conceptual = model.conceptual.replaceAll(`<h${i}`, `<h${i + 1}`).replaceAll(`</h${i}`, `</h${i + 1}`);

build.cake

@@ -1,23 +1,22 @@
 #addin nuget:?package=Cake.DocFx&version=1.0.0
-#tool dotnet:?package=docfx&version=2.75.3
+#tool dotnet:?package=docfx&version=2.70.3
 
 // this is the upcoming version, for prereleases
-var version = Argument("version", "6.3.2");
+var version = Argument("version", "6.3.1");
 var target = Argument("target", "Default");
-var gitRef = Argument("ref", "refs/heads/main");
-var buildNum = Argument("buildNum", "");
+var branch = Argument("branch", "main");
 var config = Argument("configuration", "Release");
 var serve = HasArgument("serve");
 
 Task("Prepare").Does(() => {
     DotNetWorkloadInstall("android");
-
     DotNetRestore("MLEM.sln");
     DotNetRestore("MLEM.FNA.sln");
 
-    if (!gitRef.StartsWith("refs/tags/") && !string.IsNullOrEmpty(buildNum)) {
-        Information($"Appending {buildNum} to version");
-        version += $"-ci.{buildNum}";
+    if (branch != "release") {
+        var buildNum = EnvironmentVariable("GITHUB_RUN_NUMBER");
+        if (!string.IsNullOrEmpty(buildNum))
+            version += "-ci." + buildNum;
     }
 
     DeleteFiles("**/MLEM*.nupkg");
@@ -53,16 +52,14 @@ Task("Pack").IsDependentOn("Test").Does(() => {
     DotNetPack("MLEM.FNA.sln", settings);
 });
 
-Task("Push").WithCriteria(gitRef == "refs/heads/main" || gitRef.StartsWith("refs/tags/"), "Not on main branch or tag").IsDependentOn("Pack").Does(() => {
+Task("Push").WithCriteria(branch == "main" || branch == "release", "Not on main or release branch").IsDependentOn("Pack").Does(() => {
     DotNetNuGetPushSettings settings;
-    if (gitRef.StartsWith("refs/tags/")) {
-        Information("Pushing to public feed");
+    if (branch == "release") {
         settings = new DotNetNuGetPushSettings {
             Source = "https://api.nuget.org/v3/index.json",
             ApiKey = EnvironmentVariable("NUGET_KEY")
         };
     } else {
-        Information("Pushing to private feed");
         settings = new DotNetNuGetPushSettings {
             Source = "https://nuget.ellpeck.de/v3/index.json",
             ApiKey = EnvironmentVariable("BAGET_KEY")