From eea18fb71c6c73469e57f7dcda4529a085047651 Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Fri, 18 Jun 2021 21:10:28 +0200 Subject: [PATCH] Rename towncrier folder from newsfragment to changelog.d --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- changelog.d/.gitignore | 1 + {newsfragment => changelog.d}/2449.feature | 0 {newsfragment => changelog.d}/3182.feature | 0 {newsfragment => changelog.d}/3333.bugfix | 0 {newsfragment => changelog.d}/3435.feature | 0 {newsfragment => changelog.d}/3451.feature | 0 {newsfragment => changelog.d}/3457.misc | 0 {newsfragment => changelog.d}/3459.feature | 0 {newsfragment => changelog.d}/3467.misc | 0 {newsfragment => changelog.d}/3479.removal | 0 {newsfragment => changelog.d}/3483.feature | 0 {newsfragment => changelog.d}/3485.feature | 0 {newsfragment => changelog.d}/3501.feature | 0 {newsfragment => changelog.d}/3516.misc | 0 tools/travis/check_pr.sh | 8 ++++---- towncrier.toml | 2 +- 18 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 changelog.d/.gitignore rename {newsfragment => changelog.d}/2449.feature (100%) rename {newsfragment => changelog.d}/3182.feature (100%) rename {newsfragment => changelog.d}/3333.bugfix (100%) rename {newsfragment => changelog.d}/3435.feature (100%) rename {newsfragment => changelog.d}/3451.feature (100%) rename {newsfragment => changelog.d}/3457.misc (100%) rename {newsfragment => changelog.d}/3459.feature (100%) rename {newsfragment => changelog.d}/3467.misc (100%) rename {newsfragment => changelog.d}/3479.removal (100%) rename {newsfragment => changelog.d}/3483.feature (100%) rename {newsfragment => changelog.d}/3485.feature (100%) rename {newsfragment => changelog.d}/3501.feature (100%) rename {newsfragment => changelog.d}/3516.misc (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 501aa6784a..8fbc5602fe 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,6 +5,6 @@ - [ ] Changes has been tested on an Android device or Android emulator with API 21 - [ ] UI change has been tested on both light and dark themes - [ ] Pull request is based on the develop branch -- [ ] Pull request includes a new file under ./newsfragment. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog +- [ ] Pull request includes a new file under ./changelog.d. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog - [ ] Pull request includes screenshots or videos if containing UI changes - [ ] Pull request includes a [sign off](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#sign-off) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e1758077b..cbff8652cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ This project is full Kotlin. Please do not write Java classes. ### Changelog -Please create at least one file under ./newsfragment containing details about your change. Towncrier will be used when preparing the release. +Please create at least one file under ./changelog.d containing details about your change. Towncrier will be used when preparing the release. Towncrier says to use the PR number for the filename, but the issue number is also fine. diff --git a/changelog.d/.gitignore b/changelog.d/.gitignore new file mode 100644 index 0000000000..b722e9e13e --- /dev/null +++ b/changelog.d/.gitignore @@ -0,0 +1 @@ +!.gitignore \ No newline at end of file diff --git a/newsfragment/2449.feature b/changelog.d/2449.feature similarity index 100% rename from newsfragment/2449.feature rename to changelog.d/2449.feature diff --git a/newsfragment/3182.feature b/changelog.d/3182.feature similarity index 100% rename from newsfragment/3182.feature rename to changelog.d/3182.feature diff --git a/newsfragment/3333.bugfix b/changelog.d/3333.bugfix similarity index 100% rename from newsfragment/3333.bugfix rename to changelog.d/3333.bugfix diff --git a/newsfragment/3435.feature b/changelog.d/3435.feature similarity index 100% rename from newsfragment/3435.feature rename to changelog.d/3435.feature diff --git a/newsfragment/3451.feature b/changelog.d/3451.feature similarity index 100% rename from newsfragment/3451.feature rename to changelog.d/3451.feature diff --git a/newsfragment/3457.misc b/changelog.d/3457.misc similarity index 100% rename from newsfragment/3457.misc rename to changelog.d/3457.misc diff --git a/newsfragment/3459.feature b/changelog.d/3459.feature similarity index 100% rename from newsfragment/3459.feature rename to changelog.d/3459.feature diff --git a/newsfragment/3467.misc b/changelog.d/3467.misc similarity index 100% rename from newsfragment/3467.misc rename to changelog.d/3467.misc diff --git a/newsfragment/3479.removal b/changelog.d/3479.removal similarity index 100% rename from newsfragment/3479.removal rename to changelog.d/3479.removal diff --git a/newsfragment/3483.feature b/changelog.d/3483.feature similarity index 100% rename from newsfragment/3483.feature rename to changelog.d/3483.feature diff --git a/newsfragment/3485.feature b/changelog.d/3485.feature similarity index 100% rename from newsfragment/3485.feature rename to changelog.d/3485.feature diff --git a/newsfragment/3501.feature b/changelog.d/3501.feature similarity index 100% rename from newsfragment/3501.feature rename to changelog.d/3501.feature diff --git a/newsfragment/3516.misc b/changelog.d/3516.misc similarity index 100% rename from newsfragment/3516.misc rename to changelog.d/3516.misc diff --git a/tools/travis/check_pr.sh b/tools/travis/check_pr.sh index b797244e55..d8d95879e2 100755 --- a/tools/travis/check_pr.sh +++ b/tools/travis/check_pr.sh @@ -23,7 +23,7 @@ branch=${TRAVIS_BRANCH} # If not on develop, exit, else we cannot get the list of modified files # It is ok to check only when on develop branch if [[ "${branch}" -eq 'develop' ]]; then - echo "Check that a file has been added to /newsfragment" + echo "Check that a file has been added to /changelog.d" else echo "Not on develop branch" exit 0 @@ -37,9 +37,9 @@ listOfModifiedFiles=`git diff --name-only HEAD ${branch}` # echo ${listOfModifiedFiles} -if [[ ${listOfModifiedFiles} = *"newsfragment"* ]]; then - echo "A file has been added to /newsfragment!" +if [[ ${listOfModifiedFiles} = *"changelog.d"* ]]; then + echo "A file has been added to /changelog.d!" else - echo "❌ Please add a file describing your changes in /newsfragment. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog" + echo "❌ Please add a file describing your changes in /changelog.d. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog" exit 1 fi diff --git a/towncrier.toml b/towncrier.toml index 09a927b77f..58af92ff98 100644 --- a/towncrier.toml +++ b/towncrier.toml @@ -1,5 +1,5 @@ [tool.towncrier] -directory = "newsfragment" +directory = "changelog.d" filename = "CHANGES.md" name = "Changes in Element" # Note: there is a bug, if I use title_format, the title is printed twice