Skip to content

Automate release process #1852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: release

on: push

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Release
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
body: Check CHANGELOG.md for details
21 changes: 21 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Releasing

1. Run `release.sh` script which updates versions in go.mod files and pushes a new branch to GitHub:

```shell
./scripts/release.sh -t v1.0.0
```

2. Open a pull request and wait for the build to finish.

3. Merge the pull request and run `tag.sh` to create tags for packages:

```shell
./scripts/tag.sh -t v1.0.0
```

4. Push the tags:

```shell
git push origin --tags
```
65 changes: 65 additions & 0 deletions scripts/release.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
#!/bin/bash

set -e

help() {
cat <<- EOF
Usage: TAG=tag $0

Updates version in go.mod files and pushes a new brash to GitHub.

VARIABLES:
TAG git tag, for example, v1.0.0
EOF
exit 0
}

if [ -z "$TAG" ]
then
printf "TAG is required\n\n"
help
fi

TAG_REGEX="^v(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(\\-[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"
if ! [[ "${TAG}" =~ ${TAG_REGEX} ]]; then
printf "TAG is not valid: ${TAG}\n\n"
exit 1
fi

TAG_FOUND=`git tag --list ${TAG}`
if [[ ${TAG_FOUND} = ${TAG} ]] ; then
printf "tag ${TAG} already exists\n\n"
exit 1
fi

if ! git diff --quiet
then
printf "working tree is not clean\n\n"
git status
exit 1
fi

git checkout master

PACKAGE_DIRS=$(find . -mindepth 2 -type f -name 'go.mod' -exec dirname {} \; \
| sed 's/^\.\///' \
| sort)

for dir in $PACKAGE_DIRS
do
sed --in-place \
"s/uptrace\/bun\([^ ]*\) v.*/uptrace\/bun\1 ${TAG}/" "${dir}/go.mod"
done

for dir in $PACKAGE_DIRS
do
printf "${dir}: go mod tidy\n"
(cd ./${dir} && go mod tidy)
done

sed --in-place "s/\(return \)\"[^\"]*\"/\1\"${TAG#v}\"/" ./version.go

git checkout -b release/${TAG} master
git add -u
git commit -m "Release $TAG"
git push origin release/${TAG}
40 changes: 40 additions & 0 deletions scripts/tag.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash

set -e

help() {
cat <<- EOF
Usage: TAG=tag $0

Creates git tags for public Go packages.

VARIABLES:
TAG git tag, for example, v1.0.0
EOF
exit 0
}

if [ -z "$TAG" ]
then
printf "TAG env var is required\n\n";
help
fi

if ! grep -Fq "\"${TAG#v}\"" version.go
then
printf "version.go does not contain ${TAG#v}\n"
exit 1
fi

PACKAGE_DIRS=$(find . -mindepth 2 -type f -name 'go.mod' -exec dirname {} \; \
| grep -E -v "example|internal" \
| sed 's/^\.\///' \
| sort)

git tag ${TAG}

for dir in $PACKAGE_DIRS
do
printf "tagging ${dir}/${TAG}\n"
git tag ${dir}/${TAG}
done