Rename towncrier folder from newsfragment to changelog.d

This commit is contained in:
Benoit Marty 2021-06-18 21:10:28 +02:00 committed by Benoit Marty
parent 71a8a948a6
commit eea18fb71c
18 changed files with 8 additions and 7 deletions

View File

@ -5,6 +5,6 @@
- [ ] Changes has been tested on an Android device or Android emulator with API 21 - [ ] 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 - [ ] UI change has been tested on both light and dark themes
- [ ] Pull request is based on the develop branch - [ ] 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 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) - [ ] Pull request includes a [sign off](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#sign-off)

View File

@ -53,7 +53,7 @@ This project is full Kotlin. Please do not write Java classes.
### Changelog ### 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. Towncrier says to use the PR number for the filename, but the issue number is also fine.

1
changelog.d/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
!.gitignore

View File

@ -23,7 +23,7 @@ branch=${TRAVIS_BRANCH}
# If not on develop, exit, else we cannot get the list of modified files # If not on develop, exit, else we cannot get the list of modified files
# It is ok to check only when on develop branch # It is ok to check only when on develop branch
if [[ "${branch}" -eq 'develop' ]]; then 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 else
echo "Not on develop branch" echo "Not on develop branch"
exit 0 exit 0
@ -37,9 +37,9 @@ listOfModifiedFiles=`git diff --name-only HEAD ${branch}`
# echo ${listOfModifiedFiles} # echo ${listOfModifiedFiles}
if [[ ${listOfModifiedFiles} = *"newsfragment"* ]]; then if [[ ${listOfModifiedFiles} = *"changelog.d"* ]]; then
echo "A file has been added to /newsfragment!" echo "A file has been added to /changelog.d!"
else 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 exit 1
fi fi

View File

@ -1,5 +1,5 @@
[tool.towncrier] [tool.towncrier]
directory = "newsfragment" directory = "changelog.d"
filename = "CHANGES.md" filename = "CHANGES.md"
name = "Changes in Element" name = "Changes in Element"
# Note: there is a bug, if I use title_format, the title is printed twice # Note: there is a bug, if I use title_format, the title is printed twice