google-cloud-cpp/release/changes.sh at main · comius/google-cloud-cpp · GitHub

History

executable file

140 lines (126 loc) · 4.78 KB

Raw

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

#!/bin/bash

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# https://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

# Usage:

# $ changes.sh

# Prints a summary of changes since the last release in Markdown. PRs that seem

# uninteresting to customers are omitted. The output should be pasted into the

# `CHANGELOG.md` file during a release and manually tweaked as needed.

set -euo pipefail

source "$(dirname "$0")/../ci/lib/init.sh"

cd "${PROJECT_ROOT}"

# Check that `gh` is installed so that we can give a more specific error message.

if ! command -v gh >/dev/null; then

cat <<EOF 1>&2

${BASH_ARGV0}: line ${LINENO}: command: gh: not found

You can build from source or download a binary from https://github.com/cli/cli/releases

EOF

exit 1

# Lists all the changes between the given tag and HEAD.

function list_changes() {

local since_tag="$1"

shift

git log --no-merges --format="format:%s" \

"${since_tag}"..HEAD upstream/main -- "$@"

}

# Removes changes that are likely uninteresting to customers. Changes that

# indicate they're breaking with a `!:` are always kept. Pull request numbers

# of the form `(#NNNN)` are turned into links.

function filter_messages() {

local common_filter="$1"

shift

pr_url="https://github.com/googleapis/google-cloud-cpp/pull"

for message in "$@"; do

# Filter out common changes from the service libraries.

if [ -n "${common_filter}" ]; then

if grep -qE "${common_filter}" <<<"${message}"; then

continue

# Linkify "(#NNNN)" PR numbers.

# shellcheck disable=SC2001

message="$(sed -e "s,(#$[0-9]\+$),([#\1](${pr_url}/\1)),g" <<<"${message}")"

# Breaking changes are always interesting.

if grep -qP "!:" <<<"${message}"; then

echo "${message}"

continue

# Likely uninteresting changes.

if grep -qP "^(ci|chore|test|testing|cleanup|refactor|impl)\b" <<<"${message}"; then

continue

echo "${message}"

done

}

# Prints the given changelog IFF it's not empty. The first argument is the

# title for the section, the second argument is the URL to link the title to,

# and the remaining arguments are the changelog messages to be bulleted after.

function print_changelog() {

local title=$1

local url=$2

shift 2

if [[ $# -gt 0 ]]; then

printf "\n### [%s](%s)\n\n" "${title}" "${url}"

printf -- "- %s\n" "${changelog[@]}"

}

# We'll look for changes between this tag (likely the last release) and HEAD.

last_tag="$(git describe --tags --abbrev=0 upstream/main)"

# The format is: <title>,<path>[,<extra path> ...]

sections=(

"BigQuery,google/cloud/bigquery"

"Bigtable,google/cloud/bigtable"

"OAuth2,google/cloud/oauth2"

"OpenTelemetry,google/cloud/opentelemetry"

"Pub/Sub,google/cloud/pubsub"

"Spanner,google/cloud/spanner"

"Storage,google/cloud/storage"

)

# Adds a section for "Common Libraries", which excludes the previous sections.

mapfile -t exclude < <(printf "%s\n" "${sections[@]}" |

cut -f2 -d, | sed -e 's/^/:(exclude)/')

sections+=("Common Libraries,google/cloud,${exclude[*]}")

# Use KMS as an exemplar. Assume that any changes made to it affect all

# generated libraries, and thus should be grouped under "Common Libraries".

mapfile -t common_prs < <(list_changes "${last_tag}" "google/cloud/kms" |

grep -oE "$#[0-9]+$$")

common_filter=$(printf '|%s$' "${common_prs[@]}" |

sed -e 's/^|//' -e 's/[()]/\\&/g')

for section in "${sections[@]}"; do

title="$(cut -f1 -d, <<<"${section}")"

if [ "${title}" == "Common Libraries" ]; then

filter=""

else

filter="${common_filter}"

path="$(cut -f2 -d, <<<"${section}")"

IFS=' ' read -r -a extra < <(cut -f3 -d, <<<"${section}")

url="/${path}/README.md"

mapfile -t messages < <(list_changes "${last_tag}" "${path}" "${extra[@]}")

mapfile -t changelog < <(filter_messages "${filter}" "${messages[@]}")

print_changelog "${title}" "${url}" "${changelog[@]}"

done

# Adds a section for "Google APIs interface definitions".

googleapis='googleapis/googleapis'

url="https://github.com/${googleapis}"

commit=$(sed -n -e "s:.*/${googleapis}/archive/$[a-f0-9]*$\.tar.*:\1:p" bazel/workspace0.bzl)

when=$(gh search commits --json=commit --jq '.[].commit.committer.date' --repo=${googleapis} "${commit}")

cat <<EOF

### [Google APIs interface definitions](${url})

- This release is based on definitions as of [${when}](${url}/tree/${commit})

EOF

google-cloud-cpp/release/changes.sh at main · comius/google-cloud-cpp · GitHub

Expand file tree

Breadcrumbs

changes.sh

Latest commit

History

Breadcrumbs

changes.sh

File metadata and controls