Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 44f630b261 | |||
| d916c93cf9 | |||
| 46d9be415c | |||
| b93a06d237 | |||
| 2c780b4d4e | |||
| d75fe80edb | |||
| 05d4563f00 | |||
| f81f66315a | |||
| 5ea0a48224 | |||
| efdef1e8b3 | |||
| 79118ada70 | |||
| b1ea121d53 | |||
| d7ee92f213 | |||
| 2c12675ee1 | |||
| 76981d2037 | |||
| 075ecdac5b | |||
| 1dfae6829b |
+76
-6
@@ -51,6 +51,76 @@ commands:
|
||||
paths:
|
||||
- ~/.cache/uv
|
||||
|
||||
install-zfs-from-source:
|
||||
parameters:
|
||||
zfs_release:
|
||||
type: string
|
||||
steps:
|
||||
- run:
|
||||
name: Record kernel version for cache key
|
||||
command: uname -r > /tmp/kernel-version
|
||||
- restore_cache:
|
||||
name: Restore ZFS native debs cache
|
||||
keys:
|
||||
- zfs-debs-v2-<<parameters.zfs_release>>-{{ checksum "/tmp/kernel-version" }}
|
||||
- run:
|
||||
# https://openzfs.github.io/openzfs-docs/Developer%20Resources/Building%20ZFS.html
|
||||
name: Build ZFS <<parameters.zfs_release>> native debs (if not cached)
|
||||
no_output_timeout: 20m
|
||||
command: |
|
||||
# CircleCI machine images have pyenv Python 3.13 shadowing the system
|
||||
# Python 3.12. The apt python3-* packages (setuptools, cffi, etc.) only
|
||||
# install for the system Python, and ZFS's dpkg-buildpackage needs them
|
||||
# for --enable-pyzfs. Use the system Python so apt packages are visible.
|
||||
export PYENV_VERSION=system
|
||||
if [ -d /tmp/zfs-debs ]; then
|
||||
echo "ZFS debs cache hit, skipping build"
|
||||
exit 0
|
||||
fi
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y \
|
||||
alien autoconf automake build-essential debhelper-compat dh-autoreconf \
|
||||
dh-dkms dh-python dkms fakeroot gawk git libaio-dev libattr1-dev \
|
||||
libblkid-dev libcurl4-openssl-dev libelf-dev libffi-dev libpam0g-dev \
|
||||
libssl-dev libtirpc-dev libtool libudev-dev linux-headers-$(uname -r) lsb-release \
|
||||
parallel po-debconf python3 python3-all-dev python3-cffi python3-dev \
|
||||
python3-packaging python3-setuptools python3-sphinx uuid-dev zlib1g-dev
|
||||
mkdir -p /tmp/zfs-build
|
||||
cd /tmp/zfs-build
|
||||
git clone --depth 1 --branch <<parameters.zfs_release>> https://github.com/openzfs/zfs.git zfs-src
|
||||
cd zfs-src
|
||||
sh autogen.sh
|
||||
./configure
|
||||
make native-deb
|
||||
mkdir -p /tmp/zfs-debs
|
||||
find /tmp/zfs-build -name '*.deb' -exec mv -t /tmp/zfs-debs/ {} +
|
||||
- save_cache:
|
||||
name: Save ZFS native debs cache
|
||||
key: zfs-debs-v2-<<parameters.zfs_release>>-{{ checksum "/tmp/kernel-version" }}
|
||||
paths:
|
||||
- /tmp/zfs-debs
|
||||
- run:
|
||||
name: Install ZFS <<parameters.zfs_release>>
|
||||
command: |
|
||||
ls /tmp/zfs-debs/
|
||||
# Only install the debs we need. Exclude dracut (conflicts with
|
||||
# initramfs-tools), dkms (we have prebuilt modules), and packages
|
||||
# we don't need (pyzfs, test, doc).
|
||||
sudo apt-get install -y $(find /tmp/zfs-debs -name '*.deb' \
|
||||
! -name '*dracut*' \
|
||||
! -name '*dkms*' \
|
||||
! -name '*initramfs*' \
|
||||
! -name '*pyzfs*' \
|
||||
! -name '*doc*' \
|
||||
! -name '*test*' \
|
||||
-print)
|
||||
sudo modprobe zfs
|
||||
- run:
|
||||
name: Verify ZFS version
|
||||
command: |
|
||||
sudo zfs version
|
||||
sudo zpool version
|
||||
|
||||
docs-publish-sh:
|
||||
parameters:
|
||||
push:
|
||||
@@ -135,7 +205,7 @@ workflows:
|
||||
goversion: [*latest-go-release]
|
||||
goos: ["linux"]
|
||||
goarch: ["amd64"]
|
||||
image: ["ubuntu-2204:current", "ubuntu-2404:current"]
|
||||
zfs_release: ["zfs-2.2.9", "zfs-2.3.5", "zfs-2.4.0"]
|
||||
requires:
|
||||
- test-go
|
||||
- quickcheck-go-<< matrix.goarch >>-<< matrix.goos >>-<< matrix.goversion >>
|
||||
@@ -239,10 +309,11 @@ jobs:
|
||||
type: string
|
||||
goarch:
|
||||
type: string
|
||||
image:
|
||||
zfs_release:
|
||||
type: string
|
||||
machine:
|
||||
image: <<parameters.image>>
|
||||
# pinned (not :current) to keep ZFS build cache valid across runs
|
||||
image: ubuntu-2404:2025.09.1
|
||||
resource_class: medium
|
||||
environment:
|
||||
GOOS: <<parameters.goos>>
|
||||
@@ -250,9 +321,8 @@ jobs:
|
||||
steps:
|
||||
- attach_workspace:
|
||||
at: .
|
||||
- run: sudo apt-get update
|
||||
- run: sudo apt-get install -y zfsutils-linux
|
||||
- run: sudo zfs version
|
||||
- install-zfs-from-source:
|
||||
zfs_release: <<parameters.zfs_release>>
|
||||
- run: sudo make test-platform GOOS="$GOOS" GOARCH="$GOARCH"
|
||||
|
||||
test-go:
|
||||
|
||||
@@ -7,13 +7,21 @@ import requests
|
||||
import time
|
||||
|
||||
import os
|
||||
import yaml
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
circle_token = os.environ.get('CIRCLE_TOKEN')
|
||||
if not circle_token:
|
||||
raise ValueError('CIRCLE_TOKEN environment variable not set')
|
||||
cli_yml = Path.home() / ".circleci" / "cli.yml"
|
||||
if cli_yml.exists():
|
||||
with open(cli_yml) as f:
|
||||
data = yaml.safe_load(f)
|
||||
if data:
|
||||
circle_token = data.get("token")
|
||||
if not circle_token:
|
||||
raise ValueError('CIRCLE_TOKEN not set and no token found in ~/.circleci/cli.yml')
|
||||
|
||||
parser = argparse.ArgumentParser(description='Download artifacts from CircleCI')
|
||||
parser.add_argument('build_num', type=str, help='Build number')
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
---
|
||||
description: Generate GitHub release notes from docs/changelog.rst and create a draft release with artifacts
|
||||
argument-hint: <version-tag, e.g. v0.7.0>
|
||||
model: sonnet
|
||||
allowed-tools: Read, Write
|
||||
---
|
||||
|
||||
# Task
|
||||
|
||||
Create a draft GitHub release for zrepl version $ARGUMENTS and upload release artifacts.
|
||||
|
||||
## Inputs
|
||||
|
||||
Here is the current changelog RST source:
|
||||
|
||||
!`cat docs/changelog.rst`
|
||||
|
||||
## Instructions
|
||||
|
||||
### Phase 1: Pre-flight Sanity Checks
|
||||
|
||||
Before creating the release, verify that the previous build steps have been completed.
|
||||
Run these checks using bash commands:
|
||||
|
||||
```bash
|
||||
test -d artifacts/release && echo "✓ artifacts/release directory exists" || echo "✗ Missing artifacts/release directory - run: make download-circleci-release JOB_NUM=<num>"
|
||||
test -f artifacts/release/sha512sum.txt && echo "✓ sha512sum.txt exists" || echo "✗ Missing sha512sum.txt - run: make download-circleci-release JOB_NUM=<num>"
|
||||
test -f artifacts/release/sha512sum.txt.asc && echo "✓ sha512sum.txt.asc exists (signed)" || echo "✗ Missing signature - run: make verify-and-sign"
|
||||
ls artifacts/release/zrepl-* >/dev/null 2>&1 && echo "✓ Release artifacts present" || echo "✗ No release artifacts found"
|
||||
```
|
||||
|
||||
If ANY check fails (shows ✗), **STOP** and print the error messages. Do not proceed with release creation.
|
||||
|
||||
### Phase 2: Generate Release Notes
|
||||
|
||||
2. Extract the changelog section for version $ARGUMENTS from the RST source above.
|
||||
3. Extract all GitHub usernames mentioned in that changelog section (look for @username patterns or other contributor attributions).
|
||||
4. Write a short "Highlights" section (2-4 bullets) summarizing the most impactful user-facing changes in plain language. Do NOT include commit/issue links.
|
||||
5. Write a "Contributors" thank you line for all GitHub users found in step 3. Format as: "Thanks to @user1, @user2, and @user3 for their contributions to this release!"
|
||||
6. Write a "Breaking Changes" section. Convert RST formatting to plain Markdown text (no commit or issue links):
|
||||
- `:commit:\`abc123\`` → just remove it or describe what it changed
|
||||
- `:issue:\`123\`` → just remove it or describe the issue in plain text
|
||||
- `:ref:\`display text <anchor>\`` → just use `display text` as plain text
|
||||
- `:repomasterlink:\`path\`` → just mention the path without a link
|
||||
- RST inline code ` ``code`` ` → markdown `` `code` ``
|
||||
- RST links `` `text <url>`_ `` → just use `text` without the link
|
||||
If there are no breaking changes, write "No breaking changes. vX.Y.Z-1 is interoperable with vX.Y.Z." (fill in actual versions).
|
||||
7. Assemble the full release notes using the template below. **IMPORTANT**: Do NOT include a detailed changelog list. Only include what is specified in the template.
|
||||
8. Write the result to `artifacts/release-notes.md`.
|
||||
9. Validate all links in the release notes by checking HTTP status codes with curl:
|
||||
- Extract all URLs from the markdown file
|
||||
- Check each URL with `curl -sI -w "%{http_code}" -o /dev/null <url>`
|
||||
- Report any broken links (non-200 status codes)
|
||||
- If any links are broken, stop and notify the user before creating the release
|
||||
|
||||
### Phase 3: Create Draft Release and Upload Artifacts
|
||||
|
||||
10. Run: `gh release create $ARGUMENTS --title "$ARGUMENTS" --notes-file artifacts/release-notes.md --draft`
|
||||
11. Upload all artifacts: `gh release upload $ARGUMENTS artifacts/release/*`
|
||||
12. Verify upload succeeded: `gh release view $ARGUMENTS --json assets --jq '.assets | length'`
|
||||
13. Print the release URL and confirm that artifacts were uploaded successfully.
|
||||
|
||||
## Template
|
||||
|
||||
```
|
||||
The full changelog is [on the docs site](https://zrepl.github.io/changelog.html).
|
||||
|
||||
## Highlights
|
||||
|
||||
{2-4 bullet plain-language summary of the most impactful changes}
|
||||
|
||||
{Thank all GitHub users mentioned in the changelog, e.g., "Thanks to @user1, @user2, and @user3 for their contributions to this release!"}
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
{breaking changes, or "No breaking changes."}
|
||||
|
||||
## New Users
|
||||
|
||||
We provide [quick-start guides](https://zrepl.github.io/quickstart.html) for different usage scenarios.
|
||||
We also recommend studying the [overview section of the configuration chapter](https://zrepl.github.io/configuration/overview.html).
|
||||
|
||||
## Testing & Upgrading
|
||||
|
||||
* Read the [Changelog](https://zrepl.github.io/changelog.html)
|
||||
* [Run the platform tests](https://zrepl.github.io/usage.html#platform-tests) on a test system.
|
||||
* Download & deploy the `zrepl` binary / distro package.
|
||||
|
||||
## Donations
|
||||
|
||||
zrepl is a spare-time project primarily developed by [Christian Schwarz](https://cschwarz.com).
|
||||
Express your support through a donation to keep maintenance and feature development going.
|
||||
|
||||
[](https://patreon.com/zrepl) [](https://github.com/sponsors/problame) [](https://liberapay.com/zrepl/donate) [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=R5QSXJVYHGX96)
|
||||
```
|
||||
@@ -0,0 +1,149 @@
|
||||
---
|
||||
description: Update supporters list from git history and changelog contributors
|
||||
argument-hint: <time-range-or-release>
|
||||
model: sonnet
|
||||
---
|
||||
|
||||
# Task
|
||||
|
||||
Automatically update `docs/supporters.rst` by extracting GitHub contributors from:
|
||||
1. Git commit history (code contributors)
|
||||
2. `docs/changelog.rst` (all mentioned GitHub users)
|
||||
|
||||
## Arguments
|
||||
|
||||
Specify a time range or release range to filter contributors:
|
||||
|
||||
**Time range examples:**
|
||||
- `--since="2024-01-01"` - Contributors since a specific date
|
||||
- `--since="1 year ago"` - Contributors in the last year
|
||||
- `--since="6 months ago"` - Contributors in the last 6 months
|
||||
|
||||
**Release range examples:**
|
||||
- `v0.6.0..HEAD` - Contributors between v0.6.0 and current HEAD
|
||||
- `v0.6.0..v0.7.0` - Contributors between two releases
|
||||
- `--all` - All contributors (default if no argument provided)
|
||||
|
||||
## Instructions
|
||||
|
||||
### Step 1: Extract Contributors from Git History
|
||||
|
||||
Parse the arguments to determine the git log range:
|
||||
- If `--since="..."` is provided, use: `git log --since="..." --format='%aN <%aE>' | sort -u`
|
||||
- If a commit range like `v0.6.0..HEAD` is provided, use: `git log v0.6.0..HEAD --format='%aN <%aE>' | sort -u`
|
||||
- If `--all` or no argument, use: `git log --format='%aN <%aE>' | sort -u`
|
||||
|
||||
Parse the output to identify:
|
||||
- GitHub users (look for @users.noreply.github.com emails or known GitHub patterns)
|
||||
- Real names of code contributors
|
||||
- Filter out the main maintainer (Christian Schwarz / problame) as they're already credited
|
||||
|
||||
### Step 2: Extract GitHub Users from Changelog
|
||||
|
||||
Read `docs/changelog.rst` and extract all GitHub usernames mentioned:
|
||||
- Pattern: `` `@username <https://github.com/username>`_ ``
|
||||
- Pattern: `@username` in text
|
||||
- Collect all unique usernames
|
||||
|
||||
### Step 3: Categorize Contributors
|
||||
|
||||
For each contributor, determine their tier:
|
||||
|
||||
**Code contributors** (`|supporter-code|`):
|
||||
- Anyone who appears in git history as a commit author
|
||||
- Prioritize those with substantial contributions (multiple commits)
|
||||
|
||||
**Other contributors** (keep existing `|supporter-gold|` and `|supporter-std|`):
|
||||
- Keep all existing gold/std supporters as-is (monetary supporters)
|
||||
- Only update code contributors
|
||||
|
||||
### Step 4: Read Current Supporters File
|
||||
|
||||
Read `docs/supporters.rst` and parse existing entries to:
|
||||
- Preserve all `|supporter-gold|` entries (monetary supporters - don't touch these)
|
||||
- Preserve all `|supporter-std|` entries (monetary supporters - don't touch these)
|
||||
- Preserve ALL existing `|supporter-code|` entries in their current order
|
||||
- Extract list of existing code contributor names/GitHub usernames to avoid duplicates
|
||||
|
||||
### Step 5: Identify Contributors to Promote/Add
|
||||
|
||||
**IMPORTANT: Find contributors in the range, and either ADD them (if new) or MOVE them up (if recurring).**
|
||||
|
||||
For each GitHub user found in changelog or git history for the specified range:
|
||||
1. Check if they're already listed as `|supporter-code|` in the existing file
|
||||
2. Categorize them:
|
||||
- **NEW**: Not currently in the file → will be added
|
||||
- **RECURRING**: Already in the file with new contributions in this range → will be moved to top
|
||||
- **UNCHANGED**: Not in this range → stays in original position
|
||||
3. For both NEW and RECURRING contributors:
|
||||
- Get their latest contribution date from the range: `git log <range> --author="email" --format="%ai" -1`
|
||||
- Format as: `* |supporter-code| `Name <https://github.com/username>`_`
|
||||
- Use their real name if available from git history, otherwise use GitHub username
|
||||
4. Sort NEW + RECURRING contributors together by their contribution date (newest first)
|
||||
5. Keep list of UNCHANGED contributors in their original order
|
||||
|
||||
**The final order will be: [NEW + RECURRING from range, sorted newest first] + [UNCHANGED in original order]**
|
||||
|
||||
### Step 6: Generate Updated File
|
||||
|
||||
Create the updated supporters list:
|
||||
- Keep all `|supporter-gold|` entries unchanged and in their exact positions
|
||||
- Keep all `|supporter-std|` entries unchanged and in their exact positions
|
||||
- For `|supporter-code|` entries, reorganize as follows:
|
||||
1. **Top section**: Contributors from the analyzed range (NEW + RECURRING), sorted newest first
|
||||
2. **Bottom section**: UNCHANGED contributors (not in this range), in their original order
|
||||
- Update the spacer comment showing the range that was just processed:
|
||||
```rst
|
||||
..
|
||||
↓ claude --permission-mode default /update-supporters <actual-range-used>
|
||||
```
|
||||
Replace `<actual-range-used>` with the actual argument passed (e.g., `v0.6.1..v0.7.0`)
|
||||
This comment should appear immediately before the first code contributor entry
|
||||
If there's an existing comment in this format, replace it; otherwise add it
|
||||
- Maintain all other file structure and RST formatting, including the "Before /update-supporters" marker comment
|
||||
|
||||
### Step 7: Apply Changes
|
||||
|
||||
- Use Edit tool to update the `docs/supporters.rst` file
|
||||
- Display summary of changes made:
|
||||
- Time/release range analyzed
|
||||
- Number of contributors found
|
||||
- New code contributors added
|
||||
- Final counts by tier
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
- **DO NOT modify, remove, or re-sort** any `|supporter-gold|` or `|supporter-std|` entries
|
||||
- **For code contributors**: ADD new ones and MOVE UP recurring ones (those with contributions in the analyzed range)
|
||||
- When extracting from git history, focus on substantial contributors (filter out single-commit or trivial changes if needed)
|
||||
- **CRITICAL:** Contributors from the analyzed range go to the top
|
||||
- Use `git log <range> --author="<email>" --format="%ai" -1` to get latest contribution date in the range
|
||||
- Both NEW and RECURRING contributors from this range are sorted together (newest first) and placed at the TOP
|
||||
- UNCHANGED contributors (not in this range) stay in their original relative order below
|
||||
- This creates a chronological history: most recent release's contributors appear first
|
||||
- Add/update the spacer comment showing the processed range
|
||||
- Handle edge cases:
|
||||
- Contributors mentioned in changelog but not in git history (external contributors, reporters)
|
||||
- Contributors in git history but not mentioned in changelog (decide whether to include)
|
||||
|
||||
## Example Output
|
||||
|
||||
```
|
||||
Analyzing contributors for range: v0.6.0..v0.7.0
|
||||
- Found 8 code contributors in git history
|
||||
- Found 12 GitHub users mentioned in changelog.rst (v0.7.0 section)
|
||||
- Current supporters.rst has 8 gold, 12 std, 10 code contributors
|
||||
|
||||
New contributors:
|
||||
+ Jane Doe (@janedoe)
|
||||
+ John Smith (@jsmith)
|
||||
|
||||
Promoted (recurring) contributors:
|
||||
↑ Alice Developer (@alice) - new contributions in v0.6.0..v0.7.0
|
||||
|
||||
Updated docs/supporters.rst:
|
||||
- Gold supporters: 8 (unchanged)
|
||||
- Std supporters: 12 (unchanged)
|
||||
- Code contributors: 10 → 12
|
||||
- Promoted to top: 3 contributors (2 new + 1 recurring)
|
||||
```
|
||||
@@ -56,7 +56,7 @@ release-docker-mkcachemount:
|
||||
endif
|
||||
|
||||
##################### PRODUCING A RELEASE #############
|
||||
.PHONY: release wrapup-and-checksum check-git-clean sign clean ensure-release-toolchain
|
||||
.PHONY: release wrapup-and-checksum check-git-clean verify-and-sign clean ensure-release-toolchain
|
||||
|
||||
ensure-release-toolchain:
|
||||
# ensure the toolchain is actually the one we expect
|
||||
@@ -211,7 +211,8 @@ tag-release:
|
||||
test -n "$(ZREPL_TAG_VERSION)" || exit 1
|
||||
git tag -u '328A6627FA98061D!' -m "$(ZREPL_TAG_VERSION)" "$(ZREPL_TAG_VERSION)"
|
||||
|
||||
sign:
|
||||
verify-and-sign:
|
||||
cd "$(ARTIFACTDIR)/release" && sha512sum -c sha512sum.txt
|
||||
gpg -u '328A6627FA98061D!' \
|
||||
--armor \
|
||||
--detach-sign $(ARTIFACTDIR)/release/sha512sum.txt
|
||||
@@ -222,7 +223,7 @@ clean: docs-clean
|
||||
download-circleci-release:
|
||||
rm -rf "$(ARTIFACTDIR)"
|
||||
mkdir -p "$(ARTIFACTDIR)/release"
|
||||
python3 .circleci/download_artifacts.py --prefix 'artifacts/release/' "$(BUILD_NUM)" "$(ARTIFACTDIR)/release"
|
||||
python3 .circleci/download_artifacts.py --prefix 'artifacts/release/' "$(JOB_NUM)" "$(ARTIFACTDIR)/release"
|
||||
|
||||
##################### MULTI-ARCH HELPERS #####################
|
||||
|
||||
|
||||
@@ -93,25 +93,50 @@ The procedure to issue a release is as follows:
|
||||
|
||||
* Prepare the release (as a PR to `master`):
|
||||
* Finalize `docs/changelog.rst` for the release.
|
||||
* Update the supporters list based on contributors for this release:
|
||||
```bash
|
||||
claude --permission-mode default '/update-supporters v0.6.1..v0.7.0'
|
||||
```
|
||||
Replace version tags with the appropriate range for your release.
|
||||
* Merge the PR. Docs are auto-published to zrepl.github.io on merge.
|
||||
* Tag the release:
|
||||
* Git tag the release on the `master` branch (e.g., `vMAJOR.MINOR.0`).
|
||||
```
|
||||
make tag-release ZREPL_TAG_VERSION=v0.7.0
|
||||
```
|
||||
* Push the tag.
|
||||
* Build and publish:
|
||||
* Run the `release` pipeline (trigger via CircleCI UI).
|
||||
* Download artifacts: `make download-circleci-release BUILD_NUM=<circleci-build-number>`
|
||||
* Create GitHub release and upload artifacts:
|
||||
```bash
|
||||
gh release create vX.Y.Z --title "vX.Y.Z" --notes "See changelog" --draft
|
||||
gh release upload vX.Y.Z artifacts/release/*
|
||||
* Run the `release` pipeline against the `master` branch (trigger via CircleCI UI).
|
||||
This URL: https://app.circleci.com/pipelines/github/zrepl/zrepl?branch=master.
|
||||
Example pipeline: https://app.circleci.com/pipelines/github/zrepl/zrepl/8547
|
||||
* Download artifacts using this handy makefile target.
|
||||
Note: `JOB_NUM` must be the **job number** from the `release-upload` job, **not the pipeline number**.
|
||||
Find it via: pipeline → `release` workflow → `release-upload` job number.
|
||||
Example URL: https://app.circleci.com/pipelines/github/zrepl/zrepl/8547/workflows/65feb2c9-15d7-46ab-a551-46d62a5769b0/jobs/66079/steps
|
||||
|
||||
```
|
||||
* Review the draft release, edit the changelog, then publish.
|
||||
make download-circleci-release JOB_NUM=66079
|
||||
```
|
||||
* Verify checksums and sign the checksums file:
|
||||
```
|
||||
make verify-and-sign
|
||||
```
|
||||
* Create GitHub draft release and upload artifacts:
|
||||
```bash
|
||||
claude --permission-mode default '/draft-release v0.7.0'
|
||||
```
|
||||
This command will verify that artifacts are ready, create the draft release, and upload all artifacts.
|
||||
* Review the draft release on GitHub, then publish,
|
||||
with the box checked to create a GitHub "Discussion" for the release.
|
||||
* Immediately after hitting publish.
|
||||
* Update the release on GitHub to link to the discussion.
|
||||
* Update `docs/changelog.rst` to link to the GitHub release.
|
||||
* Update `docs/_templates/versions.html` to link to the GitHub release.
|
||||
* Announce release in the zrepl Matrix channel & other socials as applicable.
|
||||
Link to the GitHub release as the entrypoint.
|
||||
* After a couple of days
|
||||
* Add the .rpm and .deb files to the official zrepl repos.
|
||||
* Code for management of these repos: https://github.com/zrepl/package-repo-ops (private repo at this time)
|
||||
* Update docs version list:
|
||||
* Update `docs/_templates/versions.html` with the new release.
|
||||
* Verify the link to `zrepl-noarch.tar` in the GitHub release works.
|
||||
* Merge to `master` (docs auto-publish).
|
||||
|
||||
#### Patch releases, Go toolchain updates, APT/RPM Package rebuilds
|
||||
|
||||
@@ -171,6 +196,8 @@ Run `make lint` and `make vet`.
|
||||
Update the CI configuration `.circleci/config.yml`:
|
||||
- Update Go version references (we reference the minimum and max supported version)
|
||||
- Set `Makefile` `RELEASE_GOVERSION` to the new Go version
|
||||
- Update the pinned ZFS release tags in the `platformtest` matrix (`zfs_release` parameter) to the latest patch releases of each OpenZFS branch (currently 2.2, 2.3, 2.4)
|
||||
- Update the pinned Ubuntu machine image for `platformtest` (e.g. `ubuntu-2404:2025.09.1`) — this is pinned rather than `current` so the ZFS build cache stays valid across runs
|
||||
|
||||
Update docs build tooling:
|
||||
- Update `uv` version in `.circleci/config.yml` (search for `astral.sh/uv/` and cache keys containing the version)
|
||||
|
||||
Vendored
+1
@@ -7,6 +7,7 @@
|
||||
<div class="rst-other-versions">
|
||||
<dl>
|
||||
<dt>Releases</dt>
|
||||
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.7.0">v0.7.0</a></dd>
|
||||
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.6.1">v0.6.1</a></dd>
|
||||
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.5.0">v0.5.0</a></dd>
|
||||
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.4.0">v0.4.0</a></dd>
|
||||
|
||||
+36
-43
@@ -13,43 +13,43 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
The changelog summarizes bugfixes that are deemed relevant for users and package maintainers.
|
||||
Developers should consult the git commit log or GitHub issue tracker.
|
||||
0.7.0
|
||||
-----
|
||||
|
||||
Next Release
|
||||
------------
|
||||
`GitHub Release <https://github.com/zrepl/zrepl/releases/tag/v0.7.0>`_
|
||||
|
||||
The plan for the next release is to revisit how zrepl does snapshot management.
|
||||
High-level goals:
|
||||
* |feature| Config file inclusion using ``include`` directive.
|
||||
This allows distributing zrepl job definitions across multiple YAML files in a ``conf.d`` style directory.
|
||||
(:commit:`4d6583e`, thanks, `@ZeyadTamimi <https://github.com/zeyadtamimi>`_).
|
||||
* |feature| Add configurable timezone for snapshot name timestamps. The default remains UTC. (:commit:`b9b9ad1`, thanks, `@mjasnik <https://github.com/mjasnik>`_).
|
||||
* |feature| Improve Grafana dashboard with additional panels and refinements (:commit:`3f75127`, thanks, `@deajan <https://github.com/deajan>`_).
|
||||
* |bugfix| Fix replication of placeholder filesystems (:commit:`5615f49`).
|
||||
* |bugfix| Avoid using the word "error" in info-level log lines about ZFS command execution (:commit:`d3b2295`, thanks, `@bakhtiyarneyman <https://github.com/bakhtiyarneyman>`_).
|
||||
* |bugfix| Detect duplicate and internal job names at config parse time.
|
||||
zrepl will now refuse to load a config with duplicate or internally reserved job names, instead of failing later at daemon startup.
|
||||
(:commit:`860a9be`).
|
||||
* |bugfix| Fix ``last_n`` keep rule behavior (:commit:`ebc46cf`, thanks, `@dsh2dsh <https://github.com/dsh2dsh>`_).
|
||||
* |bugfix| Allow different jobs to use the same ``root_fs`` for sinks (:commit:`27012e5`, thanks, `@dsh2dsh <https://github.com/dsh2dsh>`_).
|
||||
* |docs| Add installation instructions for openSUSE (:commit:`40c4827`, thanks, `@findesgh <https://github.com/findesgh>`_).
|
||||
* |docs| Improve documentation on ``send_properties`` configuration and NFS/SMB considerations (:commit:`b5d8538`, thanks, `@Malvineous <https://github.com/Malvineous>`_).
|
||||
* |docs| Warn more prominently about the risks of the ``not_replicated`` keep rule (:commit:`affe00a`, thanks, `@wxiaoguang <https://github.com/wxiaoguang>`_).
|
||||
* |docs| Improve TLS/EasyRSA setup instructions (:commit:`e524b60`, thanks, `@alorimer <https://github.com/alorimer>`_).
|
||||
* |docs| Remove dead Bountysource link (:commit:`440b074`, thanks, `@lpulley <https://github.com/lpulley>`_).
|
||||
* |docs| Fix missing newline in compile-from-source documentation (:commit:`e2fcf9f`, thanks, `@Raupinger <https://github.com/Raupinger>`_).
|
||||
* |docs| Fix apt repository installation snippet (:commit:`8305367`, thanks, `@fermino <https://github.com/fermino>`_).
|
||||
* |docs| ``zrepl.github.io``: auto-publish from ``master`` branch, retire ``stable`` branch (:commit:`4f950bb`).
|
||||
* |maint| ``zrepl status``: switch from the unmaintained ``cview`` fork back to the actively maintained ``tview`` library (:commit:`d7ede3f`).
|
||||
* |maint| Update to Go 1.25 toolchain with Go 1.24 language level & Go dependencies
|
||||
* |maint| Debian packages: proper bash completion placement (:commit:`2923009`)
|
||||
* |maint| RPM packages: AlmaLinux 8 for RPM builds (:commit:`27f4ad1`).
|
||||
* |maint| Improve build system & CI setup
|
||||
|
||||
- Make it easy to decouple snapshot management (snapshotting, pruning) from replication.
|
||||
- Ability to include/exclude snapshots from replication.
|
||||
This is useful for aforementioned decoupling, e.g., separate snapshot prefixes for local & remote replication.
|
||||
Also, it makes explicit that by default, zrepl replicates all snapshots, and that
|
||||
replication has no concept of "zrepl-created snapshots", which is a common misconception.
|
||||
- Use of ``zfs snapshot`` comma syntax or channel programs to take snapshots of multiple
|
||||
datasets atomically.
|
||||
- Provide an alternative to the ``grid`` pruning policy.
|
||||
Most likely something based on hourly/daily/weekly/monthly "trains" plus a count.
|
||||
- Ability to prune at the granularity of the **group** of snapshots created at a given
|
||||
time, as opposed to the individual snapshots within a dataset.
|
||||
Maybe this will be addressed by the alternative to the ``grid`` pruning policy,
|
||||
as it will likely be more predictable.
|
||||
|
||||
Those changes will likely come with some breakage in the config.
|
||||
However, I want to avoid breaking **use cases** that are satisfied by the current design.
|
||||
There will be beta/RC releases to give users a chance to evaluate.
|
||||
|
||||
0.7.0 (unreleased)
|
||||
------------------
|
||||
|
||||
INCOMPLETE LIST OF CHANGES
|
||||
|
||||
* |maint| Update to Go 1.25 toolchain with Go 1.24 language level.
|
||||
* |maint| Fix deprecations exposed by the toolchain update.
|
||||
* |maint| Long-overdue update of all our dependencies & address deprecations.
|
||||
* |maint| Publish docs from ``master`` branch, retire ``stable`` branch.
|
||||
* |maint| The `make release-docker` in CircleCI produces executables that are bit-identical to my personal machine.
|
||||
.. NOTE::
|
||||
| zrepl is a spare-time project primarily developed by `Christian Schwarz <https://cschwarz.com>`_.
|
||||
| You can support maintenance and feature development through one of the following services:
|
||||
| |Donate via Patreon| |Donate via GitHub Sponsors| |Donate via Liberapay| |Donate via PayPal|
|
||||
| Note that PayPal processing fees are relatively high for small donations.
|
||||
| For SEPA wire transfer and **commercial support**, please `contact Christian directly <https://cschwarz.com>`_.
|
||||
|
||||
0.6.1
|
||||
-----
|
||||
@@ -65,13 +65,6 @@ INCOMPLETE LIST OF CHANGES
|
||||
* |maint| run platform tests as part of CI.
|
||||
* |maint| build: upgrade to Go 1.21 and update golangci-lint; minimum Go version for builds is now 1.20
|
||||
|
||||
.. NOTE::
|
||||
| zrepl is a spare-time project primarily developed by `Christian Schwarz <https://cschwarz.com>`_.
|
||||
| You can support maintenance and feature development through one of the following services:
|
||||
| |Donate via Patreon| |Donate via GitHub Sponsors| |Donate via Liberapay| |Donate via PayPal|
|
||||
| Note that PayPal processing fees are relatively high for small donations.
|
||||
| For SEPA wire transfer and **commercial support**, please `contact Christian directly <https://cschwarz.com>`_.
|
||||
|
||||
0.6
|
||||
---
|
||||
|
||||
@@ -258,7 +251,7 @@ Additional changelog:
|
||||
* |bugfix| systemd + ``ssh+stdinserver``: automatically create ``/var/run/zrepl/stdinserver``
|
||||
* |bugfix| crash if Prometheus listening socket cannot be opened
|
||||
|
||||
* [MAINTAINER NOTICE] ``Makefile`` refactoring, see :commit:`080f2c0`
|
||||
* [MAINTAINER NOTICE] ``Makefile`` refactoring, see commit :commit:`080f2c0`
|
||||
|
||||
0.2
|
||||
---
|
||||
@@ -288,7 +281,7 @@ Additional changelog:
|
||||
0.1.1
|
||||
-----
|
||||
|
||||
* |bugfix| :issue:`162` :commit:`d6304f4` : fix I/O timeout errors on variable receive rate
|
||||
* |bugfix| :issue:`162` commit :commit:`d6304f4` : fix I/O timeout errors on variable receive rate
|
||||
|
||||
* A significant reduction or sudden stall of the receive rate (e.g. recv pool has other I/O to do)
|
||||
would cause a ``writev I/O timeout`` error after approximately ten seconds.
|
||||
|
||||
+1
-1
@@ -182,6 +182,6 @@ extlinks = {
|
||||
'issue':('https://github.com/zrepl/zrepl/issues/%s', 'issue #%s'),
|
||||
'repomasterlink':('https://github.com/zrepl/zrepl/blob/master/%s', '%s'),
|
||||
'sampleconf':('https://github.com/zrepl/zrepl/blob/master/internal/config/samples%s', 'internal/config/samples%s'),
|
||||
'commit':('https://github.com/zrepl/zrepl/commit/%s', 'commit %s'),
|
||||
'commit':('https://github.com/zrepl/zrepl/commit/%s', '%s'),
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
.. include:: global.rst.inc
|
||||
|
||||
.. _future:
|
||||
|
||||
Future
|
||||
======
|
||||
|
||||
This page contains some notes about future plans for zrepl.
|
||||
Then again, Christian only has very limited time available for zrepl maintenance these days.
|
||||
So, don't count on any of this happening in the near future.
|
||||
|
||||
One big development that has happened in recent years is this fork of zrepl: https://github.com/dsh2dsh/zrepl
|
||||
We should figure out whether we can pull in features from there.
|
||||
|
||||
The next major step in terms of new feature development for zrepl would be to revise snapshot management:
|
||||
|
||||
- Make it easy to decouple snapshot management (snapshotting, pruning) from replication.
|
||||
- Ability to include/exclude snapshots from replication.
|
||||
This is useful for aforementioned decoupling, e.g., separate snapshot prefixes for local & remote replication.
|
||||
Also, it makes explicit that by default, zrepl replicates all snapshots, and that
|
||||
replication has no concept of "zrepl-created snapshots", which is a common misconception.
|
||||
- Use of ``zfs snapshot`` comma syntax or channel programs to take snapshots of multiple
|
||||
datasets atomically.
|
||||
- Provide an alternative to the ``grid`` pruning policy.
|
||||
Most likely something based on hourly/daily/weekly/monthly "trains" plus a count.
|
||||
- Ability to prune at the granularity of the **group** of snapshots created at a given
|
||||
time, as opposed to the individual snapshots within a dataset.
|
||||
Maybe this will be addressed by the alternative to the ``grid`` pruning policy,
|
||||
as it will likely be more predictable.
|
||||
|
||||
Those changes will likely come with some breakage in the config.
|
||||
However, I want to avoid breaking **use cases** that are satisfied by the current design.
|
||||
There will be beta/RC releases to give users a chance to evaluate.
|
||||
@@ -136,6 +136,7 @@ Table of Contents
|
||||
usage
|
||||
pr
|
||||
changelog
|
||||
future
|
||||
GitHub Repository & Issue Tracker <https://github.com/zrepl/zrepl>
|
||||
Chat: Matrix <https://matrix.to/#/#zrepl:matrix.org>
|
||||
supporters
|
||||
|
||||
@@ -32,6 +32,30 @@ We would like to thank the following people and organizations for supporting zre
|
||||
|
||||
<div class="fa fa-code" style="width: 1em;"></div>
|
||||
|
||||
..
|
||||
The list below is (roughly) sorted by date of latest contribution, newest first.
|
||||
|
||||
..
|
||||
↓ post v0.7.0
|
||||
|
||||
* |supporter-std| `drbawb <https://git.sr.ht/~hime>`_
|
||||
|
||||
..
|
||||
↓ claude --permission-mode default /update-supporters v0.6.1..v0.7.0
|
||||
|
||||
* |supporter-code| `Bakhtiyar Neyman <https://github.com/bakhtiyarneyman>`_
|
||||
* |supporter-code| `Zeyad Tamimi <https://github.com/ZeyadTamimi>`_
|
||||
* |supporter-code| `Orsiris de Jong <https://github.com/deajan>`_
|
||||
* |supporter-code| `Martin Glatzle <https://github.com/findesgh>`_
|
||||
* |supporter-code| `Andrew Lorimer <https://github.com/alorimer>`_
|
||||
* |supporter-code| `Adam Nielsen <https://github.com/Malvineous>`_
|
||||
* |supporter-code| `wxiaoguang <https://github.com/wxiaoguang>`_
|
||||
* |supporter-code| `Logan Pulley <https://github.com/lpulley>`_
|
||||
* |supporter-code| `Florian <https://github.com/Raupinger>`_
|
||||
* |supporter-code| `Fermín Olaiz <https://github.com/fermino>`_
|
||||
* |supporter-code| `Denis Shaposhnikov <https://github.com/dsh2dsh>`_
|
||||
..
|
||||
↓ Before /update-supporters
|
||||
* |supporter-gold| `Hostsharing eG – die Hosting-Genossenschaft <https://www.hostsharing.net/>`_
|
||||
* |supporter-std| `Max Christian Pohle <https://coderonline.de>`_
|
||||
* |supporter-gold| Prominic.NET, Inc.
|
||||
|
||||
Generated
+3
-3
@@ -74,11 +74,11 @@ wheels = [
|
||||
|
||||
[[package]]
|
||||
name = "idna"
|
||||
version = "3.11"
|
||||
version = "3.15"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/6f/6d/0703ccc57f3a7233505399edb88de3cbd678da106337b9fcde432b65ed60/idna-3.11.tar.gz", hash = "sha256:795dafcc9c04ed0c1fb032c2aa73654d8e8c5023a7df64a53f39190ada629902", size = 194582, upload-time = "2025-10-12T14:55:20.501Z" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/82/77/7b3966d0b9d1d31a36ddf1746926a11dface89a83409bf1483f0237aa758/idna-3.15.tar.gz", hash = "sha256:ca962446ea538f7092a95e057da437618e886f4d349216d2b1e294abfdb65fdc", size = 199245, upload-time = "2026-05-12T22:45:57.011Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/0e/61/66938bbb5fc52dbdf84594873d5b51fb1f7c7794e9c0f5bd885f30bc507b/idna-3.11-py3-none-any.whl", hash = "sha256:771a87f49d9defaf64091e6e6fe9c18d4833f140bd19464795bc32d966ca37ea", size = 71008, upload-time = "2025-10-12T14:55:18.883Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d2/23/408243171aa9aaba178d3e2559159c24c1171a641aa83b67bdd3394ead8e/idna-3.15-py3-none-any.whl", hash = "sha256:048adeaf8c2d788c40fee287673ccaa74c24ffd8dcf09ffa555a2fbb59f10ac8", size = 72340, upload-time = "2026-05-12T22:45:55.733Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
|
||||
@@ -573,8 +573,9 @@ func implReplicationIsResumableFullSend(ctx *platformtest.Context, setup replica
|
||||
// due to step holds
|
||||
if setup.expectDatasetIsBusyErrorWhenDestroySnapshotWhilePartiallyReplicated {
|
||||
ctx.Logf("i=%v", i)
|
||||
require.Error(ctx, err)
|
||||
require.Contains(ctx, err.Error(), "dataset is busy")
|
||||
dse, ok := err.(*zfs.DestroySnapshotsError)
|
||||
require.True(ctx, ok, "expected *zfs.DestroySnapshotsError, got %T: %s", err, err)
|
||||
require.True(ctx, dse.AllReasonIsHold(), "expected hold reason, got %v", dse.Reason)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -756,11 +757,13 @@ func ReplicationIncrementalDestroysStepHoldsIffIncrementalStepHoldsAreDisabledBu
|
||||
func ReplicationStepCompletedLostBehavior__GuaranteeResumability(ctx *platformtest.Context) {
|
||||
scenario := replicationStepCompletedLostBehavior_impl(ctx, pdu.ReplicationGuaranteeKind_GuaranteeResumability)
|
||||
|
||||
require.Error(ctx, scenario.deleteSfs1Err, "protected by holds")
|
||||
require.Contains(ctx, scenario.deleteSfs1Err.Error(), "dataset is busy")
|
||||
dse1, ok := scenario.deleteSfs1Err.(*zfs.DestroySnapshotsError)
|
||||
require.True(ctx, ok, "expected *zfs.DestroySnapshotsError, got %T: %s", scenario.deleteSfs1Err, scenario.deleteSfs1Err)
|
||||
require.True(ctx, dse1.AllReasonIsHold(), "expected hold reason, got %v", dse1.Reason)
|
||||
|
||||
require.Error(ctx, scenario.deleteSfs2Err, "protected by holds")
|
||||
require.Contains(ctx, scenario.deleteSfs2Err.Error(), "dataset is busy")
|
||||
dse2, ok := scenario.deleteSfs2Err.(*zfs.DestroySnapshotsError)
|
||||
require.True(ctx, ok, "expected *zfs.DestroySnapshotsError, got %T: %s", scenario.deleteSfs2Err, scenario.deleteSfs2Err)
|
||||
require.True(ctx, dse2.AllReasonIsHold(), "expected hold reason, got %v", dse2.Reason)
|
||||
|
||||
require.Nil(ctx, scenario.finalReport.Error())
|
||||
_ = fsversion(ctx, scenario.rfs, "@3") // @3 ade it to the other side
|
||||
|
||||
@@ -31,7 +31,7 @@ func UndestroyableSnapshotParsing(t *platformtest.Context) {
|
||||
panic(dse.Filesystem)
|
||||
}
|
||||
require.Equal(t, []string{"4 5 6"}, dse.Undestroyable)
|
||||
require.Equal(t, []string{"dataset is busy"}, dse.Reason)
|
||||
require.True(t, dse.AllReasonIsHold(), "expected hold reason, got %v", dse.Reason)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1723,6 +1723,20 @@ type DestroySnapshotsError struct {
|
||||
Reason []string
|
||||
}
|
||||
|
||||
var destroySnapshotsReasonHeldRegexp = regexp.MustCompile(`^it's being held\. Run 'zfs holds -r .+' to see holders\.$`)
|
||||
|
||||
// AllReasonIsHold returns true if every undestroyable snapshot failed because
|
||||
// it is held. ZFS < 2.4 reports "dataset is busy", ZFS >= 2.4 reports
|
||||
// "it's being held. Run 'zfs holds -r <snapshot>' to see holders."
|
||||
func (e *DestroySnapshotsError) AllReasonIsHold() bool {
|
||||
for _, r := range e.Reason {
|
||||
if r != "dataset is busy" && !destroySnapshotsReasonHeldRegexp.MatchString(r) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func (e *DestroySnapshotsError) Error() string {
|
||||
if len(e.Undestroyable) != len(e.Reason) {
|
||||
panic(fmt.Sprintf("%v != %v", len(e.Undestroyable), len(e.Reason)))
|
||||
|
||||
@@ -69,7 +69,7 @@ cp -a internal/config/samples %{buildroot}%{_datadir}/
|
||||
%{_bindir}/zrepl
|
||||
%config %{_unitdir}/zrepl.service
|
||||
%dir %{_sysconfdir}/zrepl
|
||||
%config %{_sysconfdir}/zrepl/zrepl.yml
|
||||
%config(noreplace) %{_sysconfdir}/zrepl/zrepl.yml
|
||||
%{_datadir}/zsh/site-functions/_zrepl
|
||||
%{_datadir}/bash-completion/completions/zrepl
|
||||
%{_datadir}/doc/zrepl
|
||||
|
||||
Reference in New Issue
Block a user