Add changelog make target helper
Signed-off-by: Wayne Witzel III <wayne@riotousliving.com>pull/1115/head
parent
1da5702c0f
commit
1b7a64a812
|
@ -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
|
||||
|
|
3
Makefile
3
Makefile
|
@ -233,6 +233,7 @@ clean:
|
|||
docker rmi $(BUILDER_IMAGE)
|
||||
|
||||
ci: all verify test
|
||||
|
||||
changelog:
|
||||
hack/changelog.sh
|
||||
goreleaser:
|
||||
hack/goreleaser.sh
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
Example changelog entry.
|
|
@ -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}/*"
|
Loading…
Reference in New Issue