1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#!/bin/sh
# Makes a release of continuum (docs/development.md: Releasing): checks this tree, says
# how it upgrades from the release before, and commits and tags it. It pushes nothing.
#
# scripts/release [--dry-run] VERSION
#
# VERSION is the release's, X.Y.Z, later than the latest v* tag. In order:
#
# 1. The tree is clean, CHANGELOG.md has notes under Unreleased, and VERSION is later
# than the last release.
# 2. Cargo.toml takes VERSION (and Cargo.lock with it), docs/operations.md's --version
# example too; then `cargo quick`, `cargo sim` and scripts/federation-check pass.
# 3. This build's `continuum --version` and the last release's (built in
# CONTINUUM_RELEASE_TARGET, ~/.cache/continuum/release unless set) say how one upgrades:
# node by node where their wire versions meet and their Automerge is the same, else
# every node together, which takes a major release from 1.0.0 on.
# 4. CHANGELOG.md's Unreleased notes become VERSION's, under a line saying so; the
# commit `release VERSION` holds it all, tagged vVERSION, its message saying how to
# upgrade, what the build speaks and knows, and the notes. A release knowing a later
# revision of the federation than the last is tagged federation-<F>.<R> too.
#
# With --dry-run, it checks and says what it would write; it, or a check failing, leaves
# the tree as it was.
# CONTINUUM_FEATURES are the features it builds with, a transport among them
# (federation,mycelium unless given).
set -eu
dry=false
if [ "${1:-}" = --dry-run ]; then
dry=true
shift
fi
if [ $# -ne 1 ]; then
echo "usage: scripts/release [--dry-run] VERSION" >&2
exit 2
fi
version=$1
say() { echo "release: $*" >&2; }
die() {
say "$*"
exit 1
}
cd "$(git rev-parse --show-toplevel)"
features=${CONTINUUM_FEATURES:-federation,mycelium}
cache=${XDG_CACHE_HOME:-$HOME/.cache}
target=${CONTINUUM_RELEASE_TARGET:-$cache/continuum/release}
# 1. What may be released.
echo "$version" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$' || die "$version: not X.Y.Z"
[ -z "$(git status --porcelain)" ] || die "the tree isn't clean: commit or stash first"
git ls-files --error-unmatch Cargo.lock >/dev/null 2>&1 || die "Cargo.lock isn't tracked"
last=$(git tag --list 'v[0-9]*.[0-9]*.[0-9]*' --sort=-version:refname | head -n 1)
if [ -n "$last" ]; then
later=$(printf '%s\n%s\n' "${last#v}" "$version" | sort -V | tail -n 1)
[ "$later" = "$version" ] && [ "${last#v}" != "$version" ] ||
die "$version isn't later than the last release, $last"
fi
notes=$(awk '/^## Unreleased/{on=1; next} /^## /{on=0} on' CHANGELOG.md | sed '/^$/d')
[ -n "$notes" ] || die "CHANGELOG.md has nothing under Unreleased: say what changed"
work=$(mktemp -d)
committed=false
restore() {
git worktree remove --force "$work/last" >/dev/null 2>&1 || true
if ! $committed; then
git checkout -q -- Cargo.toml Cargo.lock CHANGELOG.md docs/operations.md
fi
rm -rf "$work"
}
trap restore EXIT
trap 'exit 130' INT TERM
# 2. The version taken, and the checks.
current=$(sed -n 's/^version = "\(.*\)"$/\1/p' Cargo.toml | head -n 1)
sed -i "0,/^version = \"$current\"$/s//version = \"$version\"/" Cargo.toml
sed -i "s/^# continuum [0-9][0-9.]*$/# continuum $version/" docs/operations.md
say "cargo quick"
cargo quick >&2
say "cargo sim"
cargo sim >&2
say "scripts/federation-check"
scripts/federation-check >&2
changed=$(git diff --name-only | sort | tr '\n' ' ')
case "$changed" in
"Cargo.lock Cargo.toml "* | "Cargo.toml "*) ;;
*) die "the checks changed more than the version: $changed" ;;
esac
# 3. How it upgrades from the last release.
speaks() {
cargo run -q --features "$features" --bin continuum -- --version
}
here=$(speaks)
field() { echo "$1" | sed -n "s/^$2 //p" | head -n 1; }
here_wire=$(field "$here" "wire versions")
here_automerge=$(field "$here" automerge)
here_federation=$(echo "$here" | sed -n 's/^federation \([0-9]*\): .*/\1/p')
newest_revision() {
newest=$(echo "$1" | sed -n 's/^federation [0-9]*: //p' | grep -o 'revision [0-9]*' |
tail -n 1 | sed 's/revision //')
echo "${newest:-0}"
}
here_revisions=$(newest_revision "$here")
if [ -n "$last" ]; then
git worktree add -q --detach "$work/last" "$last"
there=$(cd "$work/last" && CARGO_TARGET_DIR=$target speaks)
there_wire=$(field "$there" "wire versions")
there_automerge=$(field "$there" automerge)
there_federation=$(echo "$there" | sed -n 's/^federation \([0-9]*\): .*/\1/p')
there_revisions=$(newest_revision "$there")
if [ -z "$there_wire" ]; then
rolls=false
why="$last doesn't say which wire versions it speaks"
else
set -- $here_wire
here_oldest=$1 here_newest=$3
set -- $there_wire
there_oldest=$1 there_newest=$3
if [ "$here_oldest" -le "$there_newest" ] && [ "$there_oldest" -le "$here_newest" ]; then
rolls=true
why=""
else
rolls=false
why="no wire version both speak ($last: $there_wire; this: $here_wire)"
fi
fi
if [ "$here_automerge" != "$there_automerge" ]; then
automerge_line="Automerge $there_automerge becomes $here_automerge: remake nothing until every node runs this release."
else
automerge_line=""
fi
if $rolls; then
upgrade="From $last it rolls out node by node: install it on every node, in any order."
else
upgrade="From $last every node upgrades together: $why."
major_last=$(echo "${last#v}" | cut -d. -f1)
major_here=$(echo "$version" | cut -d. -f1)
if [ "$major_last" -ge 1 ] && [ "$major_here" -le "$major_last" ]; then
die "$why: from 1.0.0 on, that takes a major release, not $version"
fi
fi
else
upgrade="The first release made by this script."
automerge_line=""
there_revisions=$here_revisions
there_federation=$here_federation
fi
revision_tag=""
if [ -n "$here_federation" ] && [ "${here_revisions:-0}" -gt "${there_revisions:-0}" ]; then
revision_tag="federation-$here_federation.$here_revisions"
revision_line="It knows revision $here_revisions of federation $here_federation: pass a version naming it once every party's nodes run this release."
else
revision_line=""
fi
# 4. The notes, the commit and the tags.
date=$(date -u +%Y-%m-%d)
section=$(printf '%s\n' "$upgrade" "$automerge_line" "$revision_line" | sed '/^$/d')
awk -v version="$version" -v date="$date" -v section="$section" '
/^## Unreleased/ && !done {
print; print ""; print "## " version " (" date ")"; print ""; print section
done = 1; next
}
{ print }
' CHANGELOG.md >"$work/changelog"
cp "$work/changelog" CHANGELOG.md
message=$(printf 'continuum %s\n\n%s\n\n%s\n\n%s\n' "$version" "$section" \
"$(echo "$here" | tail -n +2)" "$notes")
if $dry; then
say "would commit 'release $version' and tag v$version${revision_tag:+ and $revision_tag}:"
echo "$message"
exit 0
fi
git commit -q -m "release $version" -- Cargo.toml Cargo.lock CHANGELOG.md docs/operations.md
committed=true
git tag -a -m "$message" "v$version"
if [ -n "$revision_tag" ]; then
git tag -a -m "$revision_line" "$revision_tag"
fi
say "committed and tagged v$version${revision_tag:+ and $revision_tag}; nothing pushed:"
say " git show v$version; git push origin HEAD v$version${revision_tag:+ $revision_tag}"
|