pulumi/scripts/get-version
Paul Stack 1d3c9edb6c
Ensure that make brew works as expected rather than passing empty version (#6566)
Fixes:#6565

As part of #6460, the logic for determing the version of the build was
moved to be a dependency on pulumictl.

Unfortunately, the homebrew installs use the "make dist" command to
build + install Pulumi to the user maching and as that would have a
dependency on pulumictl and it not existing on the user machine, it
would pass an empty version to the ldflag

This then manifested to the user as:

```
▶ pulumi version
warning: A new version of Pulumi is available. To upgrade from version '0.0.0' to '2.22.0', run
   $ brew upgrade pulumi
or visit https://pulumi.com/docs/reference/install/ for manual instructions and release notes.
```

We are able to mitigate this behaviour by bringing back the get-version
script and using that script as part of the make brew installation

We can see that the versions are the same between the 2 different
installation techniques

```
make dist <------- uses pulumict
DIST:
go install -ldflags "-X github.com/pulumi/pulumi/sdk/v2/go/common/version.Version=2.24.0-alpha.1616029310+787eb70a" github.com/pulumi/pulumi/sdk/v2/dotnet/cmd/pulumi-language-dotnet
DIST:
BUILD:
```

```
make brew <----- uses the legacy script
▶ make brew
BREW:
go install -ldflags "-X github.com/pulumi/pulumi/sdk/v2/go/common/version.Version=v2.24.0-alpha.1616029310+g787eb70a2" github.com/pulumi/pulumi/sdk/v2/dotnet/cmd/pulumi-language-dotnet
BREW:
```

A full post mortem will be carried out to ensure we mitigate these
types of errors going forward and that we are able to better test
these types of situations
2021-03-18 02:07:02 +00:00

107 lines
3.2 KiB
Bash
Executable file

#!/bin/bash
set -o nounset -o errexit -o pipefail
if [ $# -eq 0 ]; then
echo "No arguments provided. Pass appropriate git commit-ish value get version of (i.e. 'HEAD')"
exit 1
fi
## PLEASE NOTE: This script is used primarily for use with homebrew and the "make brew" build target
## the logic to determine the version of pulumi at build time is now controlled via
## https://github.com/pulumi/pulumictl and the `pulumictl get version` command
# Allow version to be set manually when building outside of git repo
if [ -n "${PULUMI_VERSION+x}" ]; then
echo "${PULUMI_VERSION}"
exit 0
fi
COMMITISH=$1
DIRTY_TAG=""
EXACT=0
# Figure out if the worktree is dirty, we run update-index first
# as we've seen cases in Travis where not doing so causes git to
# treat the worktree as dirty when it is not.
git update-index -q --refresh
if ! git diff-files --quiet -- . ':!**/go.mod' ':!**/go.sum'; then
DIRTY_TAG="dirty"
fi
# If we have an exact tag, just use it.
if git describe --tags --exact-match "${COMMITISH}" >/dev/null 2>&1; then
EXACT=1
TAG=$(git describe --tags --exact-match "${COMMITISH}")
# Otherwise, increment the minor version version (if the package is 1.X or later) or the
# patch version (if the package is pre 1.0), add the -alpha tag and some
# commit metadata. If there's no existing tag, pretend a v0.0.0 was
# there so we'll produce v0.0.1-dev builds.
elif git describe --tags --abbrev=0 "${COMMITISH}" > /dev/null 2>&1; then
TAG=$(git describe --tags --abbrev=0 "${COMMITISH}")
else
TAG="v0.0.0"
fi
# Check to see if the latest tag is for a submodule and transform to semver tolerant
# e.g: submodule/submodule/.../v.X.X.X
# sdk/v1.1.1 -> v1.1.1
IFS='/'
read -a tagsplit <<< "${TAG}"
if echo "${#tagsplit[@]}" > /dev/null 2>&1 -gt 1;
then
TAG=${tagsplit[${#tagsplit[@]}-1]}
fi
# if we found an exact match, return it at this point
# after we have removed any submodule prefixes.
if [ $EXACT -eq 1 ]
then
echo -n "${TAG}"
if [ ! -z "${DIRTY_TAG}" ]; then
echo -n "+${DIRTY_TAG}"
fi
echo ""
exit 0
fi
# Strip off any pre-release tag we might have (e.g. from doing a -rc build)
TAG=${TAG%%-*}
MAJOR=$(cut -d. -f1 <<< "${TAG}")
MINOR=$(cut -d. -f2 <<< "${TAG}")
PATCH=$(cut -d. -f3 <<< "${TAG}")
if [ "${MAJOR}" = "v0" ]; then
PATCH=$((${PATCH}+1))
else
MINOR=$((${MINOR}+1))
PATCH=0
fi
# if we're in a features/xxx branch and caller passed --embed-feature-branch then append `-xxx` to
# the version as well.
FEATURE_TAG=""
for arg in "$@"
do
if [[ "$arg" == "--embed-feature-branch" ]]; then
if [[ "${TRAVIS_BRANCH:-}" == features/* ]]; then
FEATURE_TAG=$(echo "${TRAVIS_BRANCH}" | sed -e 's|^features/|-|g')
fi
if [[ "${TRAVIS_BRANCH:-}" == feature-* ]]; then
FEATURE_TAG=$(echo "${TRAVIS_BRANCH}")
fi
fi
done
# We want to include some additional information. To the base tag we
# add a timestamp and commit hash. We use the timestamp of the commit
# itself, not the date it was authored (so it will change when someone
# rebases a PR into master, for example).
echo -n "${MAJOR}.${MINOR}.${PATCH}-alpha${FEATURE_TAG}.$(git show -s --format='%ct+g%h' ${COMMITISH})"
if [ ! -z "${DIRTY_TAG}" ]; then
echo -n ".${DIRTY_TAG}"
fi
echo ""