From acbf499bb7249784d5378098fa880fc25d8a2f4f Mon Sep 17 00:00:00 2001 From: haffel Date: Tue, 22 Sep 2026 16:24:34 +0200 Subject: [PATCH] Release Cliphoard 1.2.0 --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 4 +- RELEASE_NOTES.md | 21 +++++++++ RELEASING.md | 98 +++++++++++++++++++++++++++++----------- packaging/build-deb.sh | 2 +- packaging/debian/control | 2 +- 7 files changed, 98 insertions(+), 33 deletions(-) create mode 100644 RELEASE_NOTES.md diff --git a/Cargo.lock b/Cargo.lock index 5d5f5d4..d48092a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -148,7 +148,7 @@ dependencies = [ [[package]] name = "cliphoard" -version = "1.1.0" +version = "1.2.0" dependencies = [ "anyhow", "dirs", diff --git a/Cargo.toml b/Cargo.toml index 4e9b7ed..5f4a20f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "cliphoard" -version = "1.1.0" +version = "1.2.0" edition = "2021" description = "A tiny, keyboard-first clipboard history utility" license = "MIT" diff --git a/README.md b/README.md index 3aa8413..3432f65 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ with SQLCipher and unlocked with a passphrase that Cliphoard does not store. Install the package on Debian, Ubuntu, or Mint: ```bash -sudo apt install ./cliphoard_1.1.0_amd64.deb +sudo apt install ./cliphoard_1.2.0_amd64.deb ``` The package installs the `cliphoard` command, desktop launcher, tray icon, @@ -29,7 +29,7 @@ sudo apt install cargo rustc dpkg-dev libgtk-4-dev libdbus-1-dev libx11-dev libx cargo test --locked --all-features cargo build --release --locked --features gui packaging/build-deb.sh -sudo apt install ./target/cliphoard_1.1.0_amd64.deb +sudo apt install ./target/cliphoard_1.2.0_amd64.deb ``` An isolated Docker build produces the same package: diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md new file mode 100644 index 0000000..61dcd5f --- /dev/null +++ b/RELEASE_NOTES.md @@ -0,0 +1,21 @@ +# Cliphoard 1.2.0 + +## Highlights + +- Added configurable popup opacity and always-on-top behavior. +- Added settings for startup behavior, keyboard shortcut, history limits, and + retention. +- Added search reset-on-reopen and privacy-pattern clipboard filtering. +- Settings changes are persisted in the user configuration file. + +## Compatibility and migration + +This release continues to use encrypted SQLCipher storage and the existing +passphrase. No database migration is required. Plaintext databases remain +unsupported and are not opened or migrated; preserve any needed data with the +previous release before removing a plaintext database. + +## Build requirements + +Linux/X11, GTK4, and the runtime libraries listed by the Debian package are +required. See `README.md` for installation and plaintext-database handling. diff --git a/RELEASING.md b/RELEASING.md index 2104815..81e82c6 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,7 +1,7 @@ # Cliphoard release procedure -Run releases from the repository root. The current Git remote stores source -and tags, but no binary-upload destination is configured. +Run releases from the repository root. The process produces a source tag, +release binary, Debian package, checksums, and a Gitea release. ## Prepare @@ -11,10 +11,12 @@ git pull --ff-only git status --short ``` -Choose the next semantic version, for example `1.1.0`, and tag it `v1.1.0`. +Choose the next semantic version, such as `1.2.0`, and matching tag `v1.2.0`. Update the version in `Cargo.toml`, the root `cliphoard` package in `Cargo.lock`, `packaging/debian/control`, `packaging/build-deb.sh`, and the -versioned `.deb` names in `README.md`. +versioned `.deb` names in `README.md`. Review changes since the previous tag +and write notes covering features, fixes, breaking changes, migration needs, +passphrase behavior, and platform requirements. ## Verify and build @@ -23,20 +25,22 @@ cargo fmt --all -- --check cargo test --locked --all-features cargo clippy --locked --all-features -- -D warnings cargo build --release --locked --features gui -CLIPHOARD_VERSION=1.1.0 packaging/build-deb.sh -dpkg-deb --info target/cliphoard_1.1.0_amd64.deb -dpkg-deb --contents target/cliphoard_1.1.0_amd64.deb -sha256sum target/cliphoard_1.1.0_amd64.deb target/release/cliphoard +CLIPHOARD_VERSION=1.2.0 packaging/build-deb.sh +dpkg-deb --info target/cliphoard_1.2.0_amd64.deb +dpkg-deb --contents target/cliphoard_1.2.0_amd64.deb +sha256sum target/cliphoard_1.2.0_amd64.deb target/release/cliphoard > target/cliphoard_1.2.0_SHA256SUMS ``` -The Docker workflow from the README provides an isolated test, release-build, -and package-build path: +The isolated package path is: ```bash docker build -t cliphoard-builder . docker run --rm -v "$PWD/target:/out" cliphoard-builder ``` +Do not commit `target/`; retain the exact package, binary, and checksum files +for upload. + ## Commit and tag Only commit after the gates pass: @@ -45,35 +49,75 @@ Only commit after the gates pass: git diff --check git status --short git add Cargo.toml Cargo.lock README.md packaging/debian/control packaging/build-deb.sh src .agents RELEASING.md -git commit -m "Release Cliphoard 1.1.0" -git tag -a v1.1.0 -m "Release Cliphoard 1.1.0" +git commit -m "Release Cliphoard 1.2.0" +git tag -a v1.2.0 -m "Release Cliphoard 1.2.0" ``` -Replace `1.1.0` and `v1.1.0` with the actual version. +Replace `1.2.0` and `v1.2.0` with the actual version. -## Sync +## Push Git + +Confirm the remote has not moved since the preparation pull. Never force-push: ```bash git show --stat --oneline HEAD git show --no-patch --decorate HEAD git push origin main -git push origin v1.1.0 +git push origin v1.2.0 ``` -If another commit landed remotely after the initial pull, stop and resolve it -before pushing. Never force-push release history. +If the remote changed, stop and reconcile it before pushing. -## Publish the Gitea release and binary +## Publish on Gitea -Pushing Git does not upload `target/*.deb`: `target/` is ignored and the -binary is not committed. Create a Gitea release for the pushed tag, include a -summary of commits and changes, explicitly call out breaking changes, and -attach the `.deb`, release binary, and checksum file. The release must include -the plaintext-database deletion note and commands from `README.md`. +Pushing Git does not upload ignored `target/` files. Create a release for the +pushed tag and attach: + +- `target/cliphoard_1.2.0_amd64.deb` +- `target/release/cliphoard` +- `target/cliphoard_1.2.0_SHA256SUMS` + +Using the Gitea web UI: open **Releases**, choose **New Release**, select +`v1.2.0`, enter `Cliphoard 1.2.0`, paste the release notes, upload all three +files, and publish. Include breaking changes and the plaintext-database +deletion warning and commands from `README.md`. + +For API automation, create a repository release-write token and set the +installation-specific values without committing them: + +```bash +GITEA_URL="https://gitea.example.com" +GITEA_OWNER="owner" +GITEA_REPO="cliphoard" +GITEA_TOKEN="..." +VERSION="1.2.0" +TAG="v${VERSION}" +``` + +Create the release, then upload each artifact: + +```bash +release_json=$(curl --fail-with-body -sS \ + -H "Authorization: token ${GITEA_TOKEN}" \ + -H 'Content-Type: application/json' \ + -d "$(jq -n --arg tag "$TAG" --arg name "Cliphoard $VERSION" --arg body "$(cat RELEASE_NOTES.md)" \ + '{tag_name:$tag,target_commitish:"main",name:$name,body:$body,draft:false,prerelease:false}')" \ + "${GITEA_URL}/api/v1/repos/${GITEA_OWNER}/${GITEA_REPO}/releases" +release_id=$(jq -r '.id' <<<"$release_json") +for artifact in "target/cliphoard_${VERSION}_amd64.deb" "target/release/cliphoard" "target/cliphoard_${VERSION}_SHA256SUMS"; do + curl --fail-with-body -sS -H "Authorization: token ${GITEA_TOKEN}" \ + -F "attachment=@${artifact}" \ + "${GITEA_URL}/api/v1/repos/${GITEA_OWNER}/${GITEA_REPO}/releases/${release_id}/assets?name=$(basename "$artifact")" +done +``` + +Never put a token in the repository, shell history, or release notes. If no +authenticated Gitea web session or API token is available, stop after the Git +push and resume at publication. ## Final smoke check -On a clean machine or disposable environment, install the exact `.deb`, start -Cliphoard, create/unlock the encrypted database, and confirm the tray, popup, -autostart, and passphrase flows. Keep the release commit, tag, artifact name, -checksum, and test results together. +On a clean machine, install the exact `.deb`, start Cliphoard, create/unlock +the encrypted database, and check tray, popup, autostart, settings, and +passphrase flows. Verify artifacts against `cliphoard_1.2.0_SHA256SUMS` and +record the release URL, tag, checksums, and test results. diff --git a/packaging/build-deb.sh b/packaging/build-deb.sh index 0da99b7..f82c917 100755 --- a/packaging/build-deb.sh +++ b/packaging/build-deb.sh @@ -1,7 +1,7 @@ #!/bin/sh set -eu -version="${CLIPHOARD_VERSION:-1.1.0}" +version="${CLIPHOARD_VERSION:-1.2.0}" package_root="${PWD}/target/cliphoard-deb" rm -rf "$package_root" mkdir -p "$package_root/DEBIAN" \ diff --git a/packaging/debian/control b/packaging/debian/control index 29397ec..0ac0f85 100644 --- a/packaging/debian/control +++ b/packaging/debian/control @@ -1,5 +1,5 @@ Package: cliphoard -Version: 1.1.0 +Version: 1.2.0 Section: utils Priority: optional Architecture: amd64