From 1da5702c0ff5fa9171c6983ae276a062fa9d4f51 Mon Sep 17 00:00:00 2001 From: Wayne Witzel III Date: Wed, 5 Dec 2018 10:50:46 -0500 Subject: [PATCH 1/2] Move changelog entries to their own files Signed-off-by: Wayne Witzel III --- CHANGELOG.md | 3 ++- CONTRIBUTING.md | 13 +++++++++---- changelogs/unreleased/000-username | 1 + changelogs/unreleased/1048-ncdc | 1 + changelogs/unreleased/1051-omerlh | 1 + changelogs/unreleased/1054-cbeneke | 1 + changelogs/unreleased/1063-wwitzel3 | 1 + changelogs/unreleased/1069-gliptak | 1 + changelogs/unreleased/765-wwitzel3 | 1 + changelogs/unreleased/811-bashofmann | 1 + changelogs/unreleased/879-mwieczorek | 1 + 11 files changed, 20 insertions(+), 5 deletions(-) create mode 100644 changelogs/unreleased/000-username create mode 100644 changelogs/unreleased/1048-ncdc create mode 100644 changelogs/unreleased/1051-omerlh create mode 100644 changelogs/unreleased/1054-cbeneke create mode 100644 changelogs/unreleased/1063-wwitzel3 create mode 100644 changelogs/unreleased/1069-gliptak create mode 100644 changelogs/unreleased/765-wwitzel3 create mode 100644 changelogs/unreleased/811-bashofmann create mode 100644 changelogs/unreleased/879-mwieczorek diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f2e52287..d6a3f7b4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ ## Development release: - * _Example: Add XYZ support (#issue, @user)_ + * [Unreleased Changes][9] ### Bug Fixes / Other Changes * add multizone/regional support to gcp (#765, @wwitzel3) @@ -24,6 +24,7 @@ * [CHANGELOG-0.4.md][2] * [CHANGELOG-0.3.md][1] +[9]: https://github.com/heptio/ark/blob/master/changelogs/unreleased [8]: https://github.com/heptio/ark/blob/master/changelogs/CHANGELOG-0.10.md [7]: https://github.com/heptio/ark/blob/master/changelogs/CHANGELOG-0.9.md [6]: https://github.com/heptio/ark/blob/master/changelogs/CHANGELOG-0.8.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e38ca2420..e1df33575 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,15 @@ # Contributing -## Updating CHANGELOG.md +## CHANGELOG + +Authors are expected to include a changelog file with their pull requests. The changelog file +should be a new file created in the `changelogs/unreleased` folder. The file should follow the +naming convention of `issue-username` and the contents of the file should be your text for the +changelog. + + ark/changelogs/unreleased <- folder + 000-username <- file -Authors are expected include an entry to the CHANGELOG.md under the `Development release` heading -with their pull requests. During the process of creating a new release, entries from CHANGELOG.md will be -moved to the changelog for the release. ## DCO Sign off diff --git a/changelogs/unreleased/000-username b/changelogs/unreleased/000-username new file mode 100644 index 000000000..8761b1366 --- /dev/null +++ b/changelogs/unreleased/000-username @@ -0,0 +1 @@ +Example changelog entry. diff --git a/changelogs/unreleased/1048-ncdc b/changelogs/unreleased/1048-ncdc new file mode 100644 index 000000000..6c24dbbbd --- /dev/null +++ b/changelogs/unreleased/1048-ncdc @@ -0,0 +1 @@ +Remove default token from all service accounts diff --git a/changelogs/unreleased/1051-omerlh b/changelogs/unreleased/1051-omerlh new file mode 100644 index 000000000..67ae985a5 --- /dev/null +++ b/changelogs/unreleased/1051-omerlh @@ -0,0 +1 @@ +Added brew reference diff --git a/changelogs/unreleased/1054-cbeneke b/changelogs/unreleased/1054-cbeneke new file mode 100644 index 000000000..3099b1f9e --- /dev/null +++ b/changelogs/unreleased/1054-cbeneke @@ -0,0 +1 @@ +Initialize empty schedule metrics on server init diff --git a/changelogs/unreleased/1063-wwitzel3 b/changelogs/unreleased/1063-wwitzel3 new file mode 100644 index 000000000..c1d33b779 --- /dev/null +++ b/changelogs/unreleased/1063-wwitzel3 @@ -0,0 +1 @@ +Update CHANGELOGs diff --git a/changelogs/unreleased/1069-gliptak b/changelogs/unreleased/1069-gliptak new file mode 100644 index 000000000..089f15670 --- /dev/null +++ b/changelogs/unreleased/1069-gliptak @@ -0,0 +1 @@ +Update to go 1.11 diff --git a/changelogs/unreleased/765-wwitzel3 b/changelogs/unreleased/765-wwitzel3 new file mode 100644 index 000000000..9260304bf --- /dev/null +++ b/changelogs/unreleased/765-wwitzel3 @@ -0,0 +1 @@ +add multizone/regional support to gcp diff --git a/changelogs/unreleased/811-bashofmann b/changelogs/unreleased/811-bashofmann new file mode 100644 index 000000000..3678272c7 --- /dev/null +++ b/changelogs/unreleased/811-bashofmann @@ -0,0 +1 @@ +Allow to use AWS Signature v1 for creating signed AWS urls diff --git a/changelogs/unreleased/879-mwieczorek b/changelogs/unreleased/879-mwieczorek new file mode 100644 index 000000000..96790d5fc --- /dev/null +++ b/changelogs/unreleased/879-mwieczorek @@ -0,0 +1 @@ +Delete spec.priority in pod restore action From 1b7a64a812cae0769a96ac5adfa99a9f57da412f Mon Sep 17 00:00:00 2001 From: Wayne Witzel III Date: Wed, 5 Dec 2018 13:25:37 -0500 Subject: [PATCH 2/2] Add changelog make target helper Signed-off-by: Wayne Witzel III --- CONTRIBUTING.md | 2 +- Makefile | 3 ++- changelogs/unreleased/.keep | 0 changelogs/unreleased/000-username | 1 - hack/changelog.sh | 31 ++++++++++++++++++++++++++++++ 5 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 changelogs/unreleased/.keep delete mode 100644 changelogs/unreleased/000-username create mode 100755 hack/changelog.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1df33575..d935b518d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Authors are expected to include a changelog file with their pull requests. The changelog file should be a new file created in the `changelogs/unreleased` folder. The file should follow the -naming convention of `issue-username` and the contents of the file should be your text for the +naming convention of `pr-username` and the contents of the file should be your text for the changelog. ark/changelogs/unreleased <- folder diff --git a/Makefile b/Makefile index 1b0c60dcd..3244f9a69 100644 --- a/Makefile +++ b/Makefile @@ -233,6 +233,7 @@ clean: docker rmi $(BUILDER_IMAGE) ci: all verify test - +changelog: + hack/changelog.sh goreleaser: hack/goreleaser.sh diff --git a/changelogs/unreleased/.keep b/changelogs/unreleased/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/changelogs/unreleased/000-username b/changelogs/unreleased/000-username deleted file mode 100644 index 8761b1366..000000000 --- a/changelogs/unreleased/000-username +++ /dev/null @@ -1 +0,0 @@ -Example changelog entry. diff --git a/hack/changelog.sh b/hack/changelog.sh new file mode 100755 index 000000000..d216a4840 --- /dev/null +++ b/hack/changelog.sh @@ -0,0 +1,31 @@ +#!/bin/bash + +# Copyright 2018 the Heptio Ark contributors. +# +# 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 +# +# http://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. + +set -o errexit +set -o nounset +set -o pipefail + +CHANGELOG_PATH='changelogs/unreleased' +UNRELEASED=$(ls -t ${CHANGELOG_PATH}) +echo -e "Generating CHANGELOG markdown from ${CHANGELOG_PATH}\n" +for entry in $UNRELEASED +do + IFS=$'-' read -ra pruser <<<"$entry" + contents=$(cat ${CHANGELOG_PATH}/${entry}) + echo " * ${contents} (#${pruser[0]}, @${pruser[1]})" +done +echo -e "\nCopy and paste the list above in to the appropriate CHANGELOG file." +echo "Be sure to run: git rm ${CHANGELOG_PATH}/*"