Introduce a release issue template
This commit is contained in:
Aayush Rajasekaran
parent
a40fb1e1dd
commit
e6045bba85
103
documentation/misc/RELEASE_ISSUE_TEMPLATE.md
Normal file
103
documentation/misc/RELEASE_ISSUE_TEMPLATE.md
Normal file
@ -0,0 +1,103 @@
|
|||||||
|
> Release Issue Template
|
||||||
|
|
||||||
|
# Lotus X.Y.Z Release
|
||||||
|
|
||||||
|
We're happy to announce Lotus X.Y.Z...
|
||||||
|
|
||||||
|
## 🗺 What's left for release
|
||||||
|
|
||||||
|
<List of items with PRs and/or Issues to be considered for this release>
|
||||||
|
|
||||||
|
## 🚢 Estimated shipping date
|
||||||
|
|
||||||
|
<Date this release will ship on if everything goes to plan (week beginning...)>
|
||||||
|
|
||||||
|
## 🔦 Highlights
|
||||||
|
|
||||||
|
< top highlights for this release notes >
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
< changelog generated by bin/mkreleaselog >
|
||||||
|
|
||||||
|
## ✅ Release Checklist
|
||||||
|
|
||||||
|
First steps:
|
||||||
|
|
||||||
|
- [ ] Fork a new branch (`release/vX.Y.Z`) from `master` and make any further release related changes to this branch. If any "non-trivial" changes get added to the release, uncheck all the checkboxes and return to this stage.
|
||||||
|
- [ ] Prep the changelog
|
||||||
|
- [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`.
|
||||||
|
- [ ] Follow the RC release process to cut the first RC.
|
||||||
|
|
||||||
|
Prepping an RC:
|
||||||
|
|
||||||
|
- [ ] version string in `build/version.go` has been updated (in the `release/vX.Y.Z` branch).
|
||||||
|
- [ ] tag commit with `vX.Y.Z-rcN`
|
||||||
|
- [ ] cut a pre-release on [github](https://github.com/filecoin-project/lotus/releases)
|
||||||
|
|
||||||
|
Testing an RC:
|
||||||
|
|
||||||
|
- [ ] **Stage 0 - Automated Testing**
|
||||||
|
- Automated Testing
|
||||||
|
- [ ] CI: Ensure that all tests are passing.
|
||||||
|
- [ ] Testground tests
|
||||||
|
|
||||||
|
- [ ] **Stage 1 - Internal Testing**
|
||||||
|
- Upgrade our testnet infra
|
||||||
|
- [ ] 1 bootstrap node
|
||||||
|
- [ ] 1 miner
|
||||||
|
- [ ] Scratch nodes
|
||||||
|
- [ ] Wait 24 hours
|
||||||
|
- [ ] Remaining testnet infra
|
||||||
|
- Upgrade our mainnet infra
|
||||||
|
- [ ] Subset of development full archival nodes
|
||||||
|
- [ ]Subset of bootstrappers (1 per region)
|
||||||
|
- Report on new block validation time
|
||||||
|
- TODO: What other stats would we care about?
|
||||||
|
- If anything has worsened significantly, investigate + fix
|
||||||
|
- Confirm the following work (some combination of Testground / Calibnet / Mainnet / MinerX)
|
||||||
|
- [ ] Seal a sector
|
||||||
|
- [ ] make a deal
|
||||||
|
- [ ] Submit a PoSt
|
||||||
|
- [ ] (ideally) let a sector go faulty, and see it be recovered
|
||||||
|
|
||||||
|
- [ ] **Stage 2 - Community Dev Testing**
|
||||||
|
- [ ] Inform MinerX / early testers
|
||||||
|
- [ ] Ask close ecosystem partners to test their projects with the upgrade
|
||||||
|
- [ ] Powergate
|
||||||
|
- TODO: List of partners
|
||||||
|
|
||||||
|
- [ ] **Stage 3 - Community Prod Testing**
|
||||||
|
- [ ] Documentation
|
||||||
|
- [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date
|
||||||
|
- [ ] TODO: Other docs checks?
|
||||||
|
- [ ] Invite the wider community through (link to the release issue):
|
||||||
|
- [ ] TODO: How should we announce this?
|
||||||
|
|
||||||
|
- [ ] **Stage 4 - Release**
|
||||||
|
- [ ] Final preparation
|
||||||
|
- [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated.
|
||||||
|
- [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date
|
||||||
|
- [ ] Ensure that [README.md](https://github.com/filecoin-project/lotus/blob/master/README.md) is up to date
|
||||||
|
- [ ] Merge `release-vX.Y.Z` into the `releases` branch.
|
||||||
|
- [ ] Tag this merge commit (on the `releases` branch) with `vX.Y.Z`.
|
||||||
|
- [ ] Cut the release on Github.
|
||||||
|
- [ ] Final announcements
|
||||||
|
- [ ] Update network.filecoin.io
|
||||||
|
- [ ] TODO: What / where else?
|
||||||
|
|
||||||
|
- [ ] **Post-Release**
|
||||||
|
- [ ] Merge the `releases` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master).
|
||||||
|
- [ ] Create an issue using this release issue template for the _next_ release.
|
||||||
|
|
||||||
|
## ❤️ Contributors
|
||||||
|
|
||||||
|
< list generated by bin/mkreleaselog >
|
||||||
|
|
||||||
|
Would you like to contribute to Lotus and don't know how? Well, there are a few places you can get started:
|
||||||
|
|
||||||
|
- TODO
|
||||||
|
|
||||||
|
## ⁉️ Do you have questions?
|
||||||
|
|
||||||
|
TODO
|
||||||
233
scripts/mkreleaselog
Normal file
233
scripts/mkreleaselog
Normal file
@ -0,0 +1,233 @@
|
|||||||
|
#!/bin/zsh
|
||||||
|
#set -x
|
||||||
|
set -euo pipefail
|
||||||
|
export GO111MODULE=on
|
||||||
|
export GOPATH="$(go env GOPATH)"
|
||||||
|
|
||||||
|
alias jq="jq --unbuffered"
|
||||||
|
|
||||||
|
AUTHORS=(
|
||||||
|
# orgs
|
||||||
|
ipfs
|
||||||
|
ipld
|
||||||
|
libp2p
|
||||||
|
multiformats
|
||||||
|
filecoin-project
|
||||||
|
ipfs-shipyard
|
||||||
|
|
||||||
|
# Authors of personal repos used by go-ipfs that should be mentioned in the
|
||||||
|
# release notes.
|
||||||
|
whyrusleeping
|
||||||
|
Kubuxu
|
||||||
|
jbenet
|
||||||
|
Stebalien
|
||||||
|
marten-seemann
|
||||||
|
hsanjuan
|
||||||
|
lucas-clemente
|
||||||
|
warpfork
|
||||||
|
)
|
||||||
|
|
||||||
|
[[ -n "${REPO_FILTER+x}" ]] || REPO_FILTER="github.com/(${$(printf "|%s" "${AUTHORS[@]}"):1})"
|
||||||
|
|
||||||
|
[[ -n "${IGNORED_FILES+x}" ]] || IGNORED_FILES='^\(\.gx\|package\.json\|\.travis\.yml\|go.mod\|go\.sum|\.github|\.circleci\)$'
|
||||||
|
|
||||||
|
NL=$'\n'
|
||||||
|
|
||||||
|
ROOT_DIR="$(git rev-parse --show-toplevel)"
|
||||||
|
|
||||||
|
msg() {
|
||||||
|
echo "$*" >&2
|
||||||
|
}
|
||||||
|
|
||||||
|
statlog() {
|
||||||
|
local rpath="$GOPATH/src/$1"
|
||||||
|
local start="${2:-}"
|
||||||
|
local end="${3:-HEAD}"
|
||||||
|
local mailmap_file="$rpath/.mailmap"
|
||||||
|
if ! [[ -e "$mailmap_file" ]]; then
|
||||||
|
mailmap_file="$ROOT_DIR/.mailmap"
|
||||||
|
fi
|
||||||
|
|
||||||
|
git -C "$rpath" -c mailmap.file="$mailmap_file" log --use-mailmap --shortstat --no-merges --pretty="tformat:%H%n%aN%n%aE" "$start..$end" | while
|
||||||
|
read hash
|
||||||
|
read name
|
||||||
|
read email
|
||||||
|
read _ # empty line
|
||||||
|
read changes
|
||||||
|
do
|
||||||
|
changed=0
|
||||||
|
insertions=0
|
||||||
|
deletions=0
|
||||||
|
while read count event; do
|
||||||
|
if [[ "$event" =~ ^file ]]; then
|
||||||
|
changed=$count
|
||||||
|
elif [[ "$event" =~ ^insertion ]]; then
|
||||||
|
insertions=$count
|
||||||
|
elif [[ "$event" =~ ^deletion ]]; then
|
||||||
|
deletions=$count
|
||||||
|
else
|
||||||
|
echo "unknown event $event" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done<<<"${changes//,/$NL}"
|
||||||
|
|
||||||
|
jq -n \
|
||||||
|
--arg "hash" "$hash" \
|
||||||
|
--arg "name" "$name" \
|
||||||
|
--arg "email" "$email" \
|
||||||
|
--argjson "changed" "$changed" \
|
||||||
|
--argjson "insertions" "$insertions" \
|
||||||
|
--argjson "deletions" "$deletions" \
|
||||||
|
'{Commit: $hash, Author: $name, Email: $email, Files: $changed, Insertions: $insertions, Deletions: $deletions}'
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
# Returns a stream of deps changed between $1 and $2.
|
||||||
|
dep_changes() {
|
||||||
|
{
|
||||||
|
<"$1"
|
||||||
|
<"$2"
|
||||||
|
} | jq -s 'JOIN(INDEX(.[0][]; .Path); .[1][]; .Path; {Path: .[0].Path, Old: (.[1] | del(.Path)), New: (.[0] | del(.Path))}) | select(.New.Version != .Old.Version)'
|
||||||
|
}
|
||||||
|
|
||||||
|
# resolve_commits resolves a git ref for each version.
|
||||||
|
resolve_commits() {
|
||||||
|
jq '. + {Ref: (.Version|capture("^((?<ref1>.*)\\+incompatible|v.*-(0\\.)?[0-9]{14}-(?<ref2>[a-f0-9]{12})|(?<ref3>v.*))$") | .ref1 // .ref2 // .ref3)}'
|
||||||
|
}
|
||||||
|
|
||||||
|
pr_link() {
|
||||||
|
local repo="$1"
|
||||||
|
local prnum="$2"
|
||||||
|
local ghname="${repo##github.com/}"
|
||||||
|
printf -- "[%s#%s](https://%s/pull/%s)" "$ghname" "$prnum" "$repo" "$prnum"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Generate a release log for a range of commits in a single repo.
|
||||||
|
release_log() {
|
||||||
|
setopt local_options BASH_REMATCH
|
||||||
|
|
||||||
|
local repo="$1"
|
||||||
|
local start="$2"
|
||||||
|
local end="${3:-HEAD}"
|
||||||
|
local dir="$GOPATH/src/$repo"
|
||||||
|
|
||||||
|
local commit pr
|
||||||
|
git -C "$dir" log \
|
||||||
|
--format='tformat:%H %s' \
|
||||||
|
--first-parent \
|
||||||
|
"$start..$end" |
|
||||||
|
while read commit subject; do
|
||||||
|
# Skip gx-only PRs.
|
||||||
|
git -C "$dir" diff-tree --no-commit-id --name-only "$commit^" "$commit" |
|
||||||
|
grep -v "${IGNORED_FILES}" >/dev/null || continue
|
||||||
|
|
||||||
|
if [[ "$subject" =~ '^Merge pull request #([0-9]+) from' ]]; then
|
||||||
|
local prnum="${BASH_REMATCH[2]}"
|
||||||
|
local desc="$(git -C "$dir" show --summary --format='tformat:%b' "$commit" | head -1)"
|
||||||
|
printf -- "- %s (%s)\n" "$desc" "$(pr_link "$repo" "$prnum")"
|
||||||
|
elif [[ "$subject" =~ '\(#([0-9]+)\)$' ]]; then
|
||||||
|
local prnum="${BASH_REMATCH[2]}"
|
||||||
|
printf -- "- %s (%s)\n" "$subject" "$(pr_link "$repo" "$prnum")"
|
||||||
|
else
|
||||||
|
printf -- "- %s\n" "$subject"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
indent() {
|
||||||
|
sed -e 's/^/ /'
|
||||||
|
}
|
||||||
|
|
||||||
|
mod_deps() {
|
||||||
|
go list -json -m all | jq 'select(.Version != null)'
|
||||||
|
}
|
||||||
|
|
||||||
|
ensure() {
|
||||||
|
local repo="$1"
|
||||||
|
local commit="$2"
|
||||||
|
local rpath="$GOPATH/src/$repo"
|
||||||
|
if [[ ! -d "$rpath" ]]; then
|
||||||
|
msg "Cloning $repo..."
|
||||||
|
git clone "http://$repo" "$rpath" >&2
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! git -C "$rpath" rev-parse --verify "$commit" >/dev/null; then
|
||||||
|
msg "Fetching $repo..."
|
||||||
|
git -C "$rpath" fetch --all >&2
|
||||||
|
fi
|
||||||
|
|
||||||
|
git -C "$rpath" rev-parse --verify "$commit" >/dev/null || return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
statsummary() {
|
||||||
|
jq -s 'group_by(.Author)[] | {Author: .[0].Author, Commits: (. | length), Insertions: (map(.Insertions) | add), Deletions: (map(.Deletions) | add), Files: (map(.Files) | add)}' |
|
||||||
|
jq '. + {Lines: (.Deletions + .Insertions)}'
|
||||||
|
}
|
||||||
|
|
||||||
|
recursive_release_log() {
|
||||||
|
local start="${1:-$(git tag -l | sort -V | grep -v -- '-rc' | grep 'v'| tail -n1)}"
|
||||||
|
local end="${2:-$(git rev-parse HEAD)}"
|
||||||
|
local repo_root="$(git rev-parse --show-toplevel)"
|
||||||
|
local package="$(cd "$repo_root" && go list)"
|
||||||
|
|
||||||
|
if ! [[ "${GOPATH}/${package}" != "${repo_root}" ]]; then
|
||||||
|
echo "This script requires the target package and all dependencies to live in a GOPATH."
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
(
|
||||||
|
local result=0
|
||||||
|
local workspace="$(mktemp -d)"
|
||||||
|
trap "$(printf 'rm -rf "%q"' "$workspace")" INT TERM EXIT
|
||||||
|
cd "$workspace"
|
||||||
|
|
||||||
|
echo "Computing old deps..." >&2
|
||||||
|
git -C "$repo_root" show "$start:go.mod" >go.mod
|
||||||
|
mod_deps | resolve_commits | jq -s > old_deps.json
|
||||||
|
|
||||||
|
echo "Computing new deps..." >&2
|
||||||
|
git -C "$repo_root" show "$end:go.mod" >go.mod
|
||||||
|
mod_deps | resolve_commits | jq -s > new_deps.json
|
||||||
|
|
||||||
|
rm -f go.mod go.sum
|
||||||
|
|
||||||
|
printf -- "Generating Changelog for %s %s..%s\n" "$package" "$start" "$end" >&2
|
||||||
|
|
||||||
|
printf -- "- %s:\n" "$package"
|
||||||
|
release_log "$package" "$start" "$end" | indent
|
||||||
|
|
||||||
|
|
||||||
|
statlog "$package" "$start" "$end" > statlog.json
|
||||||
|
|
||||||
|
dep_changes old_deps.json new_deps.json |
|
||||||
|
jq --arg filter "$REPO_FILTER" 'select(.Path | match($filter))' |
|
||||||
|
# Compute changelogs
|
||||||
|
jq -r '"\(.Path) \(.New.Version) \(.New.Ref) \(.Old.Version) \(.Old.Ref // "")"' |
|
||||||
|
while read repo new new_ref old old_ref; do
|
||||||
|
if ! ensure "$repo" "$new_ref"; then
|
||||||
|
result=1
|
||||||
|
local changelog="failed to fetch repo"
|
||||||
|
else
|
||||||
|
statlog "$repo" "$old_ref" "$new_ref" >> statlog.json
|
||||||
|
local changelog="$(release_log "$repo" "$old_ref" "$new_ref")"
|
||||||
|
fi
|
||||||
|
if [[ -n "$changelog" ]]; then
|
||||||
|
printf -- "- %s (%s -> %s):\n" "$repo" "$old" "$new"
|
||||||
|
echo "$changelog" | indent
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "Contributors"
|
||||||
|
echo
|
||||||
|
|
||||||
|
echo "| Contributor | Commits | Lines ± | Files Changed |"
|
||||||
|
echo "|-------------|---------|---------|---------------|"
|
||||||
|
statsummary <statlog.json |
|
||||||
|
jq -s 'sort_by(.Lines) | reverse | .[]' |
|
||||||
|
jq -r '"| \(.Author) | \(.Commits) | +\(.Insertions)/-\(.Deletions) | \(.Files) |"'
|
||||||
|
return "$status"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
recursive_release_log "$@"
|
||||||
Loading…
Reference in New Issue
Block a user