Merge ~alfonsosanchezbeato/snappy-hwe-snaps/+git/jenkins-jobs:create-changelog into ~snappy-hwe-team/snappy-hwe-snaps/+git/jenkins-jobs:master

[Alfonso Sanchez-Beato]

Update ChangeLog on snap release. The format of the ChangeLog file would be as follows:

[year-moth-date] [snap name] [released version]

  [ Author <author e-mail> ]
  * Description of change 1
    Merge-Proposal: [link to lp merge proposal]
  * Description of change 2
    Merge-Proposal: [link to lp merge proposal]

  [ Author <author e-mail> ]
  * Description of change 1
    Merge-Proposal: [link to lp merge proposal]

[repetition of the previous pattern from old releases]

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

See also related MP to build-scripts: https://code.launchpad.net/~alfonsosanchezbeato/snappy-hwe-snaps/+git/build-scripts/+merge/325938

For jenkins jobs, snap-release.sh is fully copied into jenkins and not sourced, so the shebang will be respected and we will run bash as shell.

[System Enablement Bot (system-enablement-ci-bot)]

PASSED: Continuous integration, rev:41f42b3cb698bf5b7cc43330016aad91d93713f7
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1681/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/2221
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1589/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/2585

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1681/rebuild

review: Approve (continuous-integration)

[Simon Fels (morphis)]

Did you give this a try on a local jenkins instance or how did you test this?

review: Needs Information

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

@Simon I have custom jobs like https://jenkins.canonical.com/system-enablement/job/abeato-generic-release-snap/ for testing purposes.

[Simon Fels (morphis)]

LGTM, thanks!

review: Approve

diff --git a/jobs/snap/snap-release.sh b/jobs/snap/snap-release.sh
index 7de1c81..06fc6c4 100644
--- a/jobs/snap/snap-release.sh
+++ b/jobs/snap/snap-release.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 # Copyright (C) 2017 Canonical Ltd
 #
@@ -29,61 +29,142 @@ echo "New development version: $NEXT_VERSION"
 
 REPOSITORY_URL="git+ssh://$[e-mail]/~$LAUNCHPAD_TEAM/$LAUNCHPAD_PROJECT/+git/$SNAP_NAME"
 
-if [ -e $SNAP_NAME ]; then
-  rm -rf $SNAP_NAME
+if [ -e "$SNAP_NAME" ]; then
+    rm -rf "$SNAP_NAME"
 fi
 
 set_git_identity() {
-  git config user.name "System Enablement CI Bot"
-  git config user.email "[e-mail]"
+    git config user.name "System Enablement CI Bot"
+    git config user.email "[e-mail]"
 }
 
+# Arguments are:
+# $1 Snap name
+# $2 Version to release
+update_changelog() {
+    local latest_version commits i text range
+    local snap=$1
+    local ver=$2
+    local changelog_file=ChangeLog
+    local changes author full_text
+
+    # latest tag is latest version
+    latest_version="$(git describe --abbrev=0)" || true
+    if [ -n "$latest_version" ]; then
+        range=$latest_version..HEAD
+    else
+        range=HEAD
+    fi
+
+    commits=$(git rev-list --merges --reverse "$range")
+    declare -A changes
+
+    for i in $commits; do
+        local body merge_proposal description text
+
+        body=$(git log --format=%B -n1 "$i")
+        merge_proposal=$(echo "$body" | grep "^Merge-Proposal:") || true
+        author=$(echo "$body" | grep "^Author:") || true
+        author="${author#Author: *}"
+        if [ -z "$author" ]; then
+            if [ -z "$merge_proposal" ]; then
+                author="unknown"
+            else
+                author=${merge_proposal#*~}
+                author=${author%%/*}
+            fi
+        fi
+        # 'sed' removes leading blank lines first, then adds indentation
+        description=$(echo "$body" | grep -v "^Author:\|^Merge" | \
+                        sed '/./,$!d' | sed '2,$s/^/    /') || true
+        if [ -z "$description" ]; then
+            description="See more information in merge proposal"
+        fi
+        text=${changes[$author]}
+        printf -v text "%s\n  * %s\n    %s" \
+               "$text" "$description" "$merge_proposal"
+        changes[$author]=$text
+    done
+
+    printf -v full_text "%s\n" "$(date --rfc-3339=date --utc) $snap $ver"
+    for author in "${!changes[@]}"; do
+        printf -v full_text "%s\n  [ %s ]%s\n" \
+               "$full_text" "$author" "${changes[$author]}"
+    done
+
+    if [ ! -e "$changelog_file" ]; then
+        touch "$changelog_file"
+    fi
+    echo "$full_text" | cat - "$changelog_file" > "$changelog_file".tmp
+    mv "$changelog_file".tmp "$changelog_file"
+
+    git add "$changelog_file"
+    git commit -m "Update $changelog_file for $ver"
+}
+
+# Arguments are:
+# $1 Version to be set in the snapcraft.yaml file
+# $2 Path to the snapcraft.yaml file
 bump_version_and_tag() {
-  sed -i -e "s/^version:\ .*/version: $1/g" snapcraft.yaml
-  git add snapcraft.yaml
-  git commit -m "Bump version to $1"
-  git tag -a -m "$1" $1 HEAD
+    sed -i -e "s/^version:\ .*/version: $1/g" "$2"
+    git add "$2"
+    git commit -m "Bump version to $1"
+    git tag -a -m "$1" "$1" HEAD
 }
 
 RELEASE_BASE_BRANCH=master
 if [ "$RELEASE_FROM_STABLE" -eq 1 ]; then
-  RELEASE_BASE_BRANCH=stable
+    RELEASE_BASE_BRANCH=stable
 fi
 
-git clone -b $RELEASE_BASE_BRANCH $REPOSITORY_URL $SNAP_NAME
-cd $SNAP_NAME
+git clone -b "$RELEASE_BASE_BRANCH" "$REPOSITORY_URL" "$SNAP_NAME"
+cd "$SNAP_NAME"
 
-if [ ! -e snapcraft.yaml ]; then
-  echo "ERROR: No top-level snapcraft.yaml file!"
-  exit 1
+SNAPCRAFT_YAML_PATH=
+if [ -e snapcraft.yaml ]; then
+    SNAPCRAFT_YAML_PATH=snapcraft.yaml
+elif [ -e snap/snapcraft.yaml ]; then
+    SNAPCRAFT_YAML_PATH=snap/snapcraft.yaml
+fi
+
+if [ -z "$SNAPCRAFT_YAML_PATH" ]; then
+    echo "ERROR: No snapcraft.yaml or snap/snapcraft.yaml file!"
+    exit 1
 fi
 
 set_git_identity
-bump_version_and_tag $VERSION
+update_changelog "$SNAP_NAME" "$VERSION"
+bump_version_and_tag "$VERSION" "$SNAPCRAFT_YAML_PATH"
 
 if [ "$RELEASE_FROM_STABLE" -eq 1 ]; then
-  git push origin $RELEASE_BASE_BRANCH
-  git push origin $VERSION
+    git push origin "$RELEASE_BASE_BRANCH"
+    git push origin "$VERSION"
 
-  $BUILD_SCRIPTS/tools/trigger-lp-build.py -s $SNAP_NAME -p
+    "$BUILD_SCRIPTS"/tools/trigger-lp-build.py -s "$SNAP_NAME" -p
 else
-  if ! git branch -r | grep origin/stable ; then
-      git checkout -b stable origin/master
-  else
-      git checkout -b stable origin/stable
-  fi
-  git merge $RELEASE_BASE_BRANCH
-
-  git push origin stable
-  git push origin $RELEASE_BASE_BRANCH
-  git push origin $VERSION
-
-  # Build before we change master branch
-  $BUILD_SCRIPTS/tools/trigger-lp-build.py -s $SNAP_NAME -p
-
-  git checkout $RELEASE_BASE_BRANCH
-  sed -i -e "s/^version:\ .*/version: ${NEXT_VERSION}-dev/g" snapcraft.yaml
-  git add snapcraft.yaml
-  git commit -m "Open development for ${NEXT_VERSION}-dev"
-  git push origin $RELEASE_BASE_BRANCH
+    if ! git branch -r | grep origin/stable ; then
+        git checkout -b stable origin/master
+    else
+        git checkout -b stable origin/stable
+    fi
+
+    # We're using `-X theirs` here as master always takes priority over
+    # what is in the stable. If something was only submitted into stable
+    # the commiter needs to take care that the same change is submitted
+    # to master too or it is overriden the next time a release happens
+    # from master.
+    git merge --no-ff -X theirs "$RELEASE_BASE_BRANCH"
+
+    git push origin stable
+    git push origin "$RELEASE_BASE_BRANCH"
+    git push origin "$VERSION"
+
+    # Build before we change master branch
+    "$BUILD_SCRIPTS"/tools/trigger-lp-build.py -s "$SNAP_NAME" -p
+
+    git checkout "$RELEASE_BASE_BRANCH"
+    sed -i -e "s/^version:\ .*/version: ${NEXT_VERSION}-dev/g" "$SNAPCRAFT_YAML_PATH"
+    git add "$SNAPCRAFT_YAML_PATH"
+    git commit -m "Open development for ${NEXT_VERSION}-dev"
+    git push origin "$RELEASE_BASE_BRANCH"
 fi
diff --git a/tools/automerge-mps.py b/tools/automerge-mps.py
index a4e17d2..4f610a2 100755
--- a/tools/automerge-mps.py
+++ b/tools/automerge-mps.py
@@ -85,9 +85,13 @@ def try_merge(proposal, target_repo, target_branch, source_repo, source_branch):
     # FIXME: What is the real email address of the bot?
     repo.git.config("user.email", "[e-mail]")
 
+    registrant_name = proposal.registrant.display_name
+    registrant_mail = proposal.registrant.preferred_email_address.email
     repo.git.merge("--no-ff",
                    "-m", "Merge remote tracking branch %s" % (source_branch),
                    "-m", "Merge-Proposal: %s" % proposal.web_link,
+                   "-m", "Author: %s <%s>" % (registrant_name, registrant_mail),
+                   "-m", "%s" % proposal.description,
                    "source/%s" % source_branch)
 
     repo.git.push("origin", target_branch)
@@ -135,8 +139,8 @@ for proposal in proposals:
                   clean_branch_name(proposal.target_git_path),
                   launchpad.load(proposal.source_git_repository_link),
                   clean_branch_name(proposal.source_git_path))
-    except:
-        print("ERROR: Failed to merge %s" % proposal.web_link)
+    except Exception as e:
+        print("ERROR: Failed to merge %s (%s)" % (proposal.web_link, e))
         failed_merges += 1
 
 if failed_merges > 0: