[MM-19051] [MM-14180] [MM-19330] Release helpers, push to github and aws, fix weird name on msi at UAC (#1063)

* [MM-19051] release helpers

* [MM-14180] release to github

[MM-18330] more release helpers

* [MM-19330] add proper name during uac

* [MM-19051] address CR comments

* add this branch fo testing

* missing commits, remove trap to prevent ugly output

* Run shellcheck against Bash scripts to fix issues

* Try to fix build - attempt 1

* Add patch option to release script

* add setup exe installer to generate_release script

.circleci/config.yml

@@ -1,6 +1,8 @@
 version: 2.1
 orbs:
   win: circleci/windows@1.0.0
+  aws-s3: circleci/aws-s3@1.0.11
+
 executors:
   wine-chrome:
     working_directory: ~/mattermost-desktop
@@ -16,6 +18,14 @@ executors:
     working_directory: ~/mattermost-desktop
     macos:
       xcode: "10.3.0"
+  aws:
+    working_directory: ~/mattermost-desktop
+    docker:
+      - image: 'circleci/python:2.7'
+  github:
+    working_directory: ~/mattermost-desktop
+    docker:
+      - image: circleci/golang:1.12
 commands:
   update_image:
     description: "Update base image"
@@ -178,10 +188,10 @@ jobs:
       - win_make:
           operation: "build"
       - run: mkdir -p ./dist/win-release
-      - run: cp -r release/*.exe ./dist/win-release
+      #- run: cp -r release/*.exe ./dist/win-release
       - run: cp -r release/*.zip ./dist/win-release
       - run: cp -r release/*.msi ./dist/win-release
-      - run: cp -r release/*.blockmap ./dist/win-release
+      #- run: cp -r release/*.blockmap ./dist/win-release
 
       - persist_to_workspace:
           root: ./dist/
@@ -213,6 +223,39 @@ jobs:
           path: ./dist
           destination: packages
 
+  upload_to_s3:
+    executor: aws
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ./dist
+      - aws-s3/copy:
+          from: ./dist/
+          to: s3://releases.mattermost.com/desktop/$(jq -r .version package.json)/
+          arguments: --acl public-read --cache-control "no-cache" --recursive
+  upload_to_github:
+    executor: github
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ./dist
+      - run:
+          name: "Setup files for ghr"
+          command: |
+            mkdir -p ./ghr-dist
+            cp ./dist/{macos-release,win-release,linux}/* ./ghr-dist
+      - run:
+          name: "Publish Release on GitHub"
+          command: |
+            go get github.com/tcnksm/ghr
+            VERSION=$(jq -r .version package.json)
+            RELEASE_TITLE="${VERSION} ($(date -u "+%Y-%m-%d"))"
+            ghr -t ${GITHUB_TOKEN} -u ${CIRCLE_PROJECT_USERNAME} -draft \
+              --body="$(./scripts/generate_release_markdown.sh $VERSION)" \
+              --name="${RELEASE_TITLE}" $( [[ $VERSION =~ "-rc" ]] && printf %s "-prerelease") \
+              -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} \
+              -delete ${VERSION} ./ghr-dist
+
 workflows:
   version: 2
   build_and_test:
@@ -246,7 +289,7 @@ workflows:
                 # release-XX.YY.ZZ
                 # release-XX.YY.ZZ-rc-something
                 - /^release-\d+\.\d+\.\d+?(-rc.*)?/
-
+                - release-helpers # remove me
       - mac_installer:
           requires:
             - check
@@ -255,6 +298,7 @@ workflows:
             branches:
               only:
                 - /^release-\d+\.\d+\.\d+?(-rc.*)?/
+                - release-helpers # remove-me
       - store_artifacts:
           # for master/PR builds
           requires:
@@ -265,13 +309,27 @@ workflows:
             branches:
               ignore:
                 - /^release-\d+\.\d+\.\d+?(-rc.*)?/
-      - store_artifacts:
+      - upload_to_s3:
-          # for release and rc builds
+          # for release builds
           requires:
             - msi_installer
             - mac_installer
             - build-linux
+          context: mattermost-ci-s3
+          filters:
+            tags:
+              only:
+                - /^v\d+\.\d+\.\d+?$/
+                - release-helpers # remove me
+
+      - upload_to_github:
+          requires:
+            - msi_installer
+            - mac_installer
+            - build-linux
+          context: matterbuild-github-token
           filters:
             branches:
               only:
                 - /^release-\d+\.\d+\.\d+?(-rc.*)?/
+                - release-helpers # remove me

scripts/Makefile.ps1

@@ -405,22 +405,22 @@ function Run-BuildMsi {
         # Dual signing is not supported on msi files. Is it recommended to sign with 256 hash.
         # src.: https://security.stackexchange.com/a/124685/84134
         # src.: https://social.msdn.microsoft.com/Forums/windowsdesktop/en-us/d4b70ecd-a883-4289-8047-cc9cde28b492#0b3e3b80-6b3b-463f-ac1e-1bf0dc831952
-        signtool.exe sign /f "resources\windows\certificate\mattermost-desktop-windows.pfx" /p "$env:COM_MATTERMOST_MAKEFILE_CERTIFICATE_PRIVATE_KEY_ENCRYPTED" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi"
+        signtool.exe sign /f "resources\windows\certificate\mattermost-desktop-windows.pfx" /p "$env:COM_MATTERMOST_MAKEFILE_CERTIFICATE_PRIVATE_KEY_ENCRYPTED" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi" /d "mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi"
 
         Print-Info "Signing mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi (waiting for 15 seconds)..."
         Start-Sleep -s 15
-        signtool.exe sign /f "resources\windows\certificate\mattermost-desktop-windows.pfx" /p "$env:COM_MATTERMOST_MAKEFILE_CERTIFICATE_PRIVATE_KEY_ENCRYPTED" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi"
+        signtool.exe sign /f "resources\windows\certificate\mattermost-desktop-windows.pfx" /p "$env:COM_MATTERMOST_MAKEFILE_CERTIFICATE_PRIVATE_KEY_ENCRYPTED" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-\$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi" /d "mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi"
     } elseif (Test-Path 'env:PFX') {
         Print-Info "Signing mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi (waiting for 15 seconds)..."
         Start-Sleep -s 15
         # Dual signing is not supported on msi files. Is it recommended to sign with 256 hash.
         # src.: https://security.stackexchange.com/a/124685/84134
         # src.: https://social.msdn.microsoft.com/Forums/windowsdesktop/en-us/d4b70ecd-a883-4289-8047-cc9cde28b492#0b3e3b80-6b3b-463f-ac1e-1bf0dc831952
-        signtool.exe sign /f "./mattermost-desktop-windows.pfx" /p "$env:PFX_KEY" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi"
+        signtool.exe sign /f "./mattermost-desktop-windows.pfx" /p "$env:PFX_KEY" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi" /d "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x86.msi"
 
         Print-Info "Signing mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi (waiting for 15 seconds)..."
         Start-Sleep -s 15
-        signtool.exe sign /f "./mattermost-desktop-windows.pfx" /p "$env:PFX_KEY" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi"
+        signtool.exe sign /f "./mattermost-desktop-windows.pfx" /p "$env:PFX_KEY" /tr "http://timestamp.digicert.com" /fd sha256 /td sha256 "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi" /d "release\mattermost-desktop-$($env:COM_MATTERMOST_MAKEFILE_BUILD_ID)-x64.msi"
     } else {
         Print-Info "Not signing msi"
     }

scripts/cp_artifacts.sh

@@ -1,47 +1,49 @@
 #!/usr/bin/env bash
 set -eu
 
-VERSION=$(cat package.json | jq -r '.version')
+VERSION="$(jq -r '.version' <package.json)"
 SRC="${1}"
 DEST="${2}"
 SOMETHING_COPIED=0
 if [[ ! -d "${DEST}" ]]; then
-    echo "Can't find destination. Creating ${DEST}"
+    echo "Can't find destination. Creating \"${DEST}\""
-    mkdir -p ${DEST}
+    mkdir -p "${DEST}"
 fi
 
 if [[ -f "${SRC}/mattermost-desktop-${VERSION}-win-ia32.zip" ]]; then
-    echo "Copying Win32\n"
+    echo -e "Copying Win32\n"
     cp "${SRC}/mattermost-desktop-${VERSION}-win-ia32.zip" "${DEST}/mattermost-desktop-${VERSION}-win32.zip"
     SOMETHING_COPIED=1
 fi
 if [[ -f "${SRC}/mattermost-desktop-${VERSION}-win-x64.zip" ]]; then
-    echo "Copying Win64\n"
+    echo -e "Copying Win64\n"
     cp "${SRC}/mattermost-desktop-${VERSION}-win-x64.zip" "${DEST}/mattermost-desktop-${VERSION}-win64.zip"
-    SOMETHING_COPIED=$(($SOMETHING_COPIED + 2))
+    SOMETHING_COPIED=$((SOMETHING_COPIED + 2))
 fi
-if [[ -f "${SRC}/mattermost-desktop-setup-${VERSION}-win.exe" ]]; then
+# We are not supplying this since we supply the msi
-    echo "Copying win-no-arch\n"
+# if [[ -f "${SRC}/mattermost-desktop-setup-${VERSION}-win.exe" ]]; then
-    cp "${SRC}/mattermost-desktop-setup-${VERSION}-win.exe" "${DEST}/"
+#     echo -e "Copying win-no-arch\n"
-    SOMETHING_COPIED=$(($SOMETHING_COPIED + 4))
+#     cp "${SRC}/mattermost-desktop-setup-${VERSION}-win.exe" "${DEST}/"
-fi
+#     SOMETHING_COPIED=$((SOMETHING_COPIED + 4))
-if [[ -f "${SRC}"/mattermost-desktop-${VERSION}-mac.zip ]]; then
+# fi
-    echo "Copying mac\n"
+if [[ -f "${SRC}/mattermost-desktop-${VERSION}-mac.zip" ]]; then
+    echo -e "Copying mac\n"
     cp "${SRC}"/mattermost-desktop-*-mac.* "${DEST}/"
     if [[ -f "${SRC}"/mattermost-desktop-${VERSION}-mac.dmg ]]; then
         cp "${SRC}"/*.blockmap "${DEST}/"
     fi
-    SOMETHING_COPIED=$(($SOMETHING_COPIED + 8))
+    SOMETHING_COPIED=$((SOMETHING_COPIED + 8))
 fi
 if [[ -f "${SRC}"/mattermost-desktop-${VERSION}-linux-x64.tar.gz ]]; then
-    echo "Copying linux"
+    echo -e "Copying linux\n"
     cp "${SRC}"/mattermost-desktop-*-linux-* "${DEST}/"
-    SOMETHING_COPIED=$(($SOMETHING_COPIED + 16))
+    SOMETHING_COPIED=$((SOMETHING_COPIED + 16))
 fi
 
 if [[ $SOMETHING_COPIED -eq 0 ]]; then
-    echo "didn't find anything to copy, seems like something failed"
+    echo "Didn't find anything to copy, it seems like something failed"
-    exit -1
+    # Bash only returns 0-255 values
+    exit 1
 fi
 
 cp "${SRC}"/*.yml "${DEST}/"

scripts/generate_release_markdown.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 set -eu
 
-function print_link() {
+# Requires sha256sum, on osx you can do
+# brew install coreutils
+
+function print_link {
   local URL="${1}"
   local CHECKSUM="$(curl -s -S -L "${URL}" | sha256sum | awk '{print $1}')"
   echo "- ${URL}"
@@ -15,13 +18,16 @@ cat <<-MD
 ### Mattermost Desktop ${VERSION} has been cut!
 The download links can be found below.
 
-#### Windows
+#### Windows - msi files (beta)
-$(print_link "${BASE_URL}/mattermost-setup-${VERSION}-win32.exe")
+$(print_link "${BASE_URL}/mattermost-desktop-v${VERSION}-x64.msi")
-$(print_link "${BASE_URL}/mattermost-setup-${VERSION}-win64.exe")
+$(print_link "${BASE_URL}/mattermost-desktop-v${VERSION}-x86.msi")
+
+#### Windows - setup exe files
+$(print_link "${BASE_URL}/mattermost-desktop-setup-${VERSION}-win.exe")
 
 #### Windows - zip files
-$(print_link "${BASE_URL}/mattermost-desktop-${VERSION}-win32.zip")
+$(print_link "${BASE_URL}/mattermost-desktop-${VERSION}-win-ia32.zip")
-$(print_link "${BASE_URL}/mattermost-desktop-${VERSION}-win64.zip")
+$(print_link "${BASE_URL}/mattermost-desktop-${VERSION}-win-x64.zip")
 
 #### Mac
 $(print_link "${BASE_URL}/mattermost-desktop-${VERSION}-mac.dmg")

scripts/release.sh

@@ -0,0 +1,194 @@
+#!/usr/bin/env bash
+
+# exit when any command fails
+set -e
+
+function print_error {
+    echo -e "[ERROR  ] $*"
+}
+function print_warning {
+    echo -e "[WARNING] $*"
+}
+function print_info {
+    echo -e "[INFO   ] $*"
+}
+
+function tag {
+    # not forcing tags, this might fail on purpose if tags are already created 
+    # as we don't want to overwrite automatically.
+    # if this happens, you should check that versions are ok and see if there are
+    # any tags locally or upstream that might conflict.
+    git tag -a "v${1}" -m "Desktop Version ${2}"
+}
+
+function write_package_version {
+    temp_file="$(mktemp -t package.json)"
+    jq ".version = \"${1}\"" ./package.json > "${temp_file}" && mv "${temp_file}" ./package.json
+    temp_file="$(mktemp -t package-lock.json)"
+    jq ".version = \"${1}\"" ./package-lock.json > "${temp_file}" && mv "${temp_file}" ./package-lock.json
+    temp_file="$(mktemp -t src-package.json)"
+    jq ".version = \"${1}\"" ./src/package.json > "${temp_file}" && mv "${temp_file}" ./src/package.json
+    temp_file="$(mktemp -t src-package-lock.json)"
+    jq ".version = \"${1}\"" ./src/package-lock.json > "${temp_file}" && mv "${temp_file}" ./src/package-lock.json
+    
+    git add ./package.json ./package-lock.json ./src/package.json ./src/package-lock.json
+    git commit -qm "Bump to version ${1}"
+}
+
+
+# keep track of the last executed command
+# src.: https://stackoverflow.com/a/6110446/3514658
+trap 'last_command=$current_command; current_command=$BASH_COMMAND' DEBUG
+# echo an error message before exiting
+trap 'echo "\"${last_command}\" command filed with exit code $?."' EXIT
+
+# mattermost repo might not be the origin one, we don't want to enforce that.
+org="github.com:mattermost"
+git_origin="$(git remote -v | grep ${org} | grep push | awk '{print $1}')"
+if [[ -z "${git_origin}" ]]; then
+    print_warning "Can't find a mattermost remote, defaulting to origin"
+    git_origin="origin"
+fi
+
+# get original git branch
+branch_name="$(git symbolic-ref -q HEAD)"
+branch_name="${branch_name##refs/heads/}"
+branch_name="${branch_name:-HEAD}"
+
+# don't run if branch is dirty, releases shouldn't be done on a dirty branch
+dirty="$(git diff --quiet && echo 0 || echo 1)"
+if (( dirty == 1 )); then
+    print_error "Please use this script on a clean branch"
+    exit 10
+fi
+
+# require jq
+if ! type jq >/dev/null 2>&1; then
+    print_error "This script requires jq to run"
+    exit 11
+fi
+
+# get version
+pkg_version="$(jq -r .version package.json)"
+# remove trailing
+current_version="${pkg_version%-develop}"
+current_version="${pkg_version%-rc*}"
+# parse version
+IFS='.' read -r major minor micro <<<"${current_version}"
+case "${1}" in
+    "help")
+        echo "todo"
+    ;;
+    "rc")
+        if [[ "${branch_name}" =~ "release-" ]]; then
+            if [[ "${pkg_version}" =~ "-rc" ]]; then
+                rc="${pkg_version#*-rc}"
+            else
+                print_warning "No release candidate on the version, assuming 0"
+                rc=0
+            fi
+            case "${rc}" in
+                ''|*[!0-9]*) 
+                    print_warning "Can't guess release candidate from version, assuming 0"
+                    rc=1
+                ;;
+                *)
+                    rc=$(( rc + 1 ))
+                ;;
+            esac
+            print_info "Generating ${current_version} release candidate ${rc}"
+            new_pkg_version="${current_version}-rc${rc}"
+            write_package_version "${new_pkg_version}"
+            tag "${new_pkg_version}" "Release candidate ${rc}"
+            print_info "Locally created an rc. In order to build you'll have to:"
+            print_info "$ git push --follow-tags ${git_origin} ${branch_name}:${branch_name}"
+        else
+            print_error "Can't generate a release candidate on a non release-X.Y branch"
+            exit 2
+
+        fi
+    ;;
+    "final")
+        if [[ "${branch_name}" =~ "release-" ]]; then
+            print_info "Releasing v${current_version}"
+            new_pkg_version="${current_version}"
+            write_package_version "${new_pkg_version}"
+            tag "${new_pkg_version}" "Released on $(date -u)"
+            print_info "Locally created an final version. In order to build you'll have to:"
+            print_info "$ git push --follow-tags ${git_origin} ${branch_name}:${branch_name}"
+        else
+            print_error "Can't release on a non release-X.Y branch"
+            exit 2
+        fi
+    ;;
+    "patch")
+        if [[ "${branch_name}" =~ "release-" ]]; then
+            new_pkg_version="${major}.${minor}.$(( micro + 1 ))"
+            print_info "Releasing v${new_pkg_version}"
+            write_package_version "${new_pkg_version}"
+            tag "${new_pkg_version}" "Released on $(date -u)"
+            print_info "Locally created an patch version. In order to build you'll have to:"
+            print_info "$ git push --follow-tags ${git_origin} ${branch_name}:${branch_name}"
+        else
+            print_error "Can't patch on a non release-X.Y branch"
+            exit 2
+        fi
+    ;;
+    "branch")
+        # Quality releases should run from a release branch
+        if [[ "${branch_name}" =~ "release-" ]]; then
+            new_branch_version="${major}.$(( minor + 1 ))"
+            new_branch_name="release-${new_branch_version}"
+            print_info "Doing a quality branch: ${new_branch_name}"
+
+            if git show-ref --verify --quiet "refs/heads/${new_branch_name}"; then
+                print_error "Branch ${new_branch_name} exists"
+                exit 3
+            fi
+
+            new_pkg_version="${new_branch_version}.0-rc0"
+            git checkout -b "${new_branch_name}"
+            write_package_version "${new_pkg_version}"
+            tag "${new_pkg_version}" "Quality branch"
+            print_info "Locally created quality branch. In order to build you'll have to:"
+            print_info "$ git push --follow-tags ${git_origin} ${new_branch_name}:${new_branch_name}"
+
+        else
+            if [[ "${branch_name}" != "master" ]]; then
+                print_warning "You are branching on ${branch_name} instead of master or a release-branch"
+                read -p "Do you wish to continue? [y/n]" -n 1 -r
+                if [[ ! "${REPLY}" =~ ^[Yy]$ ]]; then
+                    exit 1
+                fi
+            fi
+            new_branch_version="${major}.${minor}"
+            new_branch_name="release-${new_branch_version}"
+            new_pkg_version="${new_branch_version}.0-rc0"
+            master_pkg_version="${major}.$(( minor + 2 )).0-develop"
+            print_info "Creating a new features branch: ${new_branch_name}"
+
+            if git show-ref --verify --quiet "refs/heads/${new_branch_name}"; then
+                print_error "Branch ${new_branch_name} exists"
+                exit 3
+            fi
+
+            git branch "${new_branch_name}"
+            print_info "Writing new package version for development: ${master_pkg_version}"
+            write_package_version "${master_pkg_version}"
+            git checkout "${new_branch_name}"
+            write_package_version "${new_pkg_version}"
+            tag "${new_pkg_version}" "New features branch"
+            print_info "Locally created new features branch. In order to build you'll have to:"
+            print_info "$ git push --follow-tags ${git_origin} ${new_branch_name}:${new_branch_name}"
+            print_info "For writing master changes you'll need to:"
+            print_info "$ git push ${git_origin} ${branch_name}:${branch_name}"
+        fi
+    ;;
+    *)
+        print_error "Only branch|rc|final parameters are accepted"
+        exit 1
+    ;;
+esac
+
+trap - EXIT
+