From 0d749b3e7a4bea9d0f74a18e89db9d9f96bf7fee Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Mon, 29 Jun 2020 20:21:07 -0400 Subject: [PATCH] docs: break out bc-break and refactors in changelog [ci skip] --- contrib/release-dokku | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/contrib/release-dokku b/contrib/release-dokku index d52990684..41ce6b805 100755 --- a/contrib/release-dokku +++ b/contrib/release-dokku @@ -239,7 +239,7 @@ fn-repo-update-history-and-commit() { declare desc="Updates the history file and commits the changes" declare CURRENT_VERSION="$1" NEXT_VERSION="$2" local PULL_REQUEST_ID TITLE AUTHOR TYPE CHANGELOG_TEXT - local COMMIT_MESSAGE HISTORY HISTORY_CONTENTS HISTORY_DOCUMENTATION HISTORY_ENHANCEMENT HISTORY_BUG HISTORY_OTHER HISTORY_TESTS ISSUE_FILE + local COMMIT_MESSAGE HISTORY HISTORY_CONTENTS HISTORY_DOCUMENTATION HISTORY_ENHANCEMENT HISTORY_BC_BREAK HISTORY_REFACTOR HISTORY_BUG HISTORY_OTHER HISTORY_TESTS ISSUE_FILE pushd "$ROOT_DIR" >/dev/null @@ -256,12 +256,16 @@ fn-repo-update-history-and-commit() { TYPE="$(jq -r '.labels[] | select( .name | contains("type") ) | .name' "$ISSUE_FILE" | cut -d' ' -f2)" CHANGELOG_TEXT="- #${PULL_REQUEST_ID}: @${AUTHOR} ${TITLE}" - if [[ "$TYPE" == "bug" ]]; then + if [[ "$TYPE" == "bc-break" ]]; then + HISTORY_BC_BREAK="${HISTORY_BC_BREAK}"$'\n'"$CHANGELOG_TEXT" + elif [[ "$TYPE" == "bug" ]]; then HISTORY_BUG="${HISTORY_BUG}"$'\n'"$CHANGELOG_TEXT" elif [[ "$TYPE" == "documentation" ]]; then HISTORY_DOCUMENTATION="${HISTORY_DOCUMENTATION}"$'\n'"$CHANGELOG_TEXT" - elif [[ "$TYPE" == "enhancement" ]] || [[ "$TYPE" == "refactor" ]]; then + elif [[ "$TYPE" == "enhancement" ]]; then HISTORY_ENHANCEMENT="${HISTORY_ENHANCEMENT}"$'\n'"$CHANGELOG_TEXT" + elif [[ "$TYPE" == "refactor" ]]; then + HISTORY_REFACTOR="${HISTORY_REFACTOR}"$'\n'"$CHANGELOG_TEXT" elif [[ "$TYPE" == "tests" ]]; then HISTORY_TESTS="${HISTORY_TESTS}"$'\n'"$CHANGELOG_TEXT" else @@ -277,6 +281,11 @@ fn-repo-update-history-and-commit() { HISTORY="${HISTORY}"$'\n'"sudo DOKKU_TAG=v${NEXT_VERSION} bash bootstrap.sh" HISTORY="${HISTORY}"$'\n'"\`\`\`" + if [[ "$HISTORY_BC_BREAK" ]]; then + HISTORY="${HISTORY}"$'\n\n'"### Backwards Compatibility Breaks" + HISTORY="${HISTORY}"$'\n'"$HISTORY_BC_BREAK" + fi + if [[ "$HISTORY_BUG" ]]; then HISTORY="${HISTORY}"$'\n\n'"### Bug Fixes" HISTORY="${HISTORY}"$'\n'"$HISTORY_BUG" @@ -287,6 +296,11 @@ fn-repo-update-history-and-commit() { HISTORY="${HISTORY}"$'\n'"$HISTORY_ENHANCEMENT" fi + if [[ "$HISTORY_REFACTOR" ]]; then + HISTORY="${HISTORY}"$'\n\n'"### Refactors" + HISTORY="${HISTORY}"$'\n'"$HISTORY_REFACTOR" + fi + if [[ "$HISTORY_DOCUMENTATION" ]]; then HISTORY="${HISTORY}"$'\n\n'"### Documentation" HISTORY="${HISTORY}"$'\n'"$HISTORY_DOCUMENTATION"