Followup to the 0.5.0 release

.github/workflows/docker.yml

@@ -2,8 +2,6 @@ name: Build Docker
 
 on:
   push:
-    branches:
-      - '*'
     tags:
       - '*'
 

README.md

@@ -27,6 +27,11 @@ use a reverse proxy such as Nginx, haproxy, or Apache httpd.
 
 ### Using Docker-Compose
 
+Every release of the server generates a Docker image in
+`ghcr.io/gothenburgbitfactory/taskchampion-sync-server`. The tags include
+`latest` for the latest release, and both minor and patch versions, e.g., `0.5`
+and `0.5.1`.
+
 The [`docker-compose.yml`](./docker-compose.yml) file in this repository is
 sufficient to run taskchampion-sync-server, including setting up TLS
 certificates using Lets Encrypt, thanks to [Caddy](https://caddyserver.com/).
@@ -44,9 +49,9 @@ TASKCHAMPION_SYNC_SERVER_HOSTNAME=taskwarrior.example.com docker compose up
 ```
 
 It can take a few minutes to obtain the certificate; the caddy container will
-log a msg "certificate obtained successfully" when this is complete, or error
-messages if the process fails. Once this process is complete, configure your
-`.taskrc`'s to point to the server:
+log a message "certificate obtained successfully" when this is complete, or
+error messages if the process fails. Once this process is complete, configure
+your `.taskrc`'s to point to the server:
 
 ```
 sync.server.url=https://taskwarrior.example.com
@@ -108,6 +113,7 @@ cargo build --release
 
 After build the binary is located in
 `target/release/taskchampion-sync-server`.
+
 ### Building the Container
 
 To build the container execute the following commands.

RELEASING.md

@@ -0,0 +1,19 @@
+# Release process
+
+1. Run `git pull upstream main`
+1. Run `cargo test`
+1. Run `cargo clean && cargo clippy`
+1. Remove the `-pre` from `version` in all `*/Cargo.toml`, and from the `version = ..` in any references between packages.
+1. Run `cargo semver-checks` (https://crates.io/crates/cargo-semver-checks)
+1. Run `cargo build --release`
+1. Commit the changes (Cargo.lock will change too) with comment `vX.Y.Z`.
+1. Run `git tag vX.Y.Z`
+1. Run `git push upstream`
+1. Run `git push upstream --tag vX.Y.Z`
+1. Run `cargo publish -p taskchampion-sync-server-core`
+1. Run `cargo publish -p taskchampion-sync-server-storage-sqlite` (and add any other new published packages here)
+1. Bump the patch version in `*/Cargo.toml` and add the `-pre` suffix. This allows `cargo-semver-checks` to check for changes not accounted for in the version delta.
+1. Run `cargo build --release` again to update `Cargo.lock`
+1. Commit that change with comment "Bump to -pre version".
+1. Run `git push upstream`
+1. Navigate to the tag in the GitHub releases UI and create a release with general comments about the changes in the release

core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "taskchampion-sync-server-core"
-version = "0.5.0-pre"
+version = "0.5.1-pre"
 authors = ["Dustin J. Mitchell <[email protected]>"]
 edition = "2021"
 description = "Core of sync protocol for TaskChampion"

docker-compose.yml

@@ -46,7 +46,7 @@ services:
         condition: service_completed_successfully
 
   tss:
-    image: ghcr.io/gothenburgbitfactory/taskchampion-sync-server:main
+    image: ghcr.io/gothenburgbitfactory/taskchampion-sync-server:latest
     restart: unless-stopped
     volumes:
       - type: volume

server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "taskchampion-sync-server"
-version = "0.4.1"
+version = "0.5.1-pre"
 authors = ["Dustin J. Mitchell <[email protected]>"]
 edition = "2021"
 publish = false

sqlite/Cargo.toml

@@ -1,13 +1,13 @@
 [package]
 name = "taskchampion-sync-server-storage-sqlite"
-version = "0.5.0-pre"
+version = "0.5.1-pre"
 authors = ["Dustin J. Mitchell <[email protected]>"]
 edition = "2021"
 description = "SQLite backend for TaskChampion-sync-server"
 license = "MIT"
 
 [dependencies]
-taskchampion-sync-server-core = { path = "../core", version = "0.5.0-pre" }
+taskchampion-sync-server-core = { path = "../core", version = "0.5.1-pre" }
 uuid.workspace = true
 anyhow.workspace = true
 thiserror.workspace = true