CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove towncrier (#3661)

Browse Source
This commit is contained in:
jack1142 2020-03-28 02:46:15 +01:00 committed by GitHub
parent 9370b5110e
commit 9552d210f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
42 changed files with 9 additions and 228 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -6,6 +6,7 @@
!/tests/cogs/dataconverter/data/**/*.json
Pipfile
Pipfile.lock
.directory
### JetBrains template
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm

39
.github/CONTRIBUTING.md → CONTRIBUTING.md
View File

@ -11,9 +11,8 @@
* [4.4 Make](#44-make)
* [4.5 Keeping your dependencies up to date](#45-keeping-your-dependencies-up-to-date)
* [4.6 To contribute changes](#46-to-contribute-changes)
* [4.7 Using towncrier](#47-using-towncrier)
* [4.8 How To Report A Bug](#48-how-to-report-a-bug)
* [4.9 How To Suggest A Feature Or Enhancement](#49-how-to-suggest-a-feature-or-enhancement)
* [4.7 How To Report A Bug](#47-how-to-report-a-bug)
* [4.8 How To Suggest A Feature Or Enhancement](#48-how-to-suggest-a-feature-or-enhancement)
* [5. Code Review Process](#5-code-review-process)
* [5.1 Issues](#51-issues)
* [5.2 Pull Requests](#52-pull-requests)
@ -116,39 +115,17 @@ Whenever you pull from upstream (V3/develop on the main repository) and you noti
1. Create a new branch on your fork
2. Make the changes
3. If you like the changes and think the main Red project could use it:
* Create a towncrier entry for the changes. (See next section for details)
* Run tests with `tox` to ensure your code is up to scratch
* Create a Pull Request on GitHub with your changes
- If you are contributing a behavior change, please keep in mind that behavior changes
are conditional on them being appropriate for the project's current goals.
If you would like to reduce the risk of putting in effort for something we aren't
going to use, open an issue discussing it first.
### 4.7 Using towncrier
Red uses towncrier to create changelogs.
To create a towncrier entry for your PR, create a file in `changelog.d` for it. If the changes are for a specific cog, place the file in the related subdirectory.
The filename should be of the format `issuenumber.changetype(.count).rst`, where `(.count)` is an optional
part of the filename should multiple entries for the same issue number and type be necessary.
If there is not an issue associated with your PR,
you may use the PR number in place of the issue number.
Valid changetypes are:
* breaking : Breaking changes
* dep : Changes to dependencies
* enhance : Enhancements
* feature : New features
* bugfix : Bugfixes
* docs : documentation improvements and additions
* removal : removal of something
* misc : any changes which don't have a user facing change, and don't belong in the changelog for users
The contents of the file should be a short, human readable description of the impact of the changes made,
not the technical details of the change.
### 4.8 How To Report A Bug
### 4.7 How To Report A Bug
Please see our **ISSUES.MD** for more information.
### 4.9 How To Suggest A Feature Or Enhancement
### 4.8 How To Suggest A Feature Or Enhancement
The goal of Red is to be as useful to as many people as possible, this means that all features must be useful to anyone and any server that uses Red.
If you find yourself wanting a feature that Red does not already have, you're probably not alone. There's bound to be a great number of users out there needing the same thing and a lot of the features that Red has today have been added because of the needs of our users. Open an issue on our issues list and describe the feature you would like to see, how you would use it, how it should work, and why it would be useful to the Red community as a whole.

5
Makefile
View File

@ -27,8 +27,3 @@ newenv:
$(MAKE) syncenv
syncenv:
.venv/bin/pip install -Ur ./tools/dev-requirements.txt
# Changelog check
checkchangelog:
bash tools/check_changelog_entries.sh
$(PYTHON) -m towncrier --draft

1
changelog.d/.gitignore vendored
View File

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

1
changelog.d/3256.dep.rst
View File

@ -1 +0,0 @@
Use websockets 8.1

4
changelog.d/3472.enhance.rst
View File

@ -1,4 +0,0 @@
Add caching for ignored channels/guilds.
Add caching for white/blacklist.
Add consume-rest for white/blacklist commands.
Allow ignoring channel categories.

1
changelog.d/3526.enhance.rst
View File

@ -1 +0,0 @@
Show DeprecationWarning's

1
changelog.d/admin/.gitignore vendored
View File

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

1
changelog.d/alias/.gitignore vendored
View File

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

1
changelog.d/audio/.gitignore vendored
View File

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

1
changelog.d/audio/3201.feature.1.rst
View File

@ -1 +0,0 @@
``[p]remove`` command now accepts an URL or Index, if an URL is used it will remove all tracks in the queue with that URL.

1
changelog.d/bank/.gitignore vendored
View File

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

1
changelog.d/cleanup/.gitignore vendored
View File

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

1
changelog.d/customcom/.gitignore vendored
View File

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

1
changelog.d/downloader/.gitignore vendored
View File

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

1
changelog.d/economy/.gitignore vendored
View File

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

1
changelog.d/economy/3438.bugfix.rst
View File

@ -1 +0,0 @@
Changes next_payday to last_payday. last_payday stores the latest time the command runned successfully, allows the command to dynamicly change with the PAYDAY_TIME variable, by checking if last_payday + PAYDAY_TIME >= current time.

1
changelog.d/filter/.gitignore vendored
View File

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

1
changelog.d/general/.gitignore vendored
View File

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

1
changelog.d/general/2382.enhancement.rst
View File

@ -1 +0,0 @@
Show more details in [p]serverinfo command when using a toggle.

1
changelog.d/image/.gitignore vendored
View File

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

1
changelog.d/mod/.gitignore vendored
View File

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

1
changelog.d/mod/3472.enhance.rst
View File

@ -1 +0,0 @@
Move ignore commands and checks into core.

2
changelog.d/mod/3523.bugfix.rst
View File

@ -1,2 +0,0 @@
Allow mentions in hackban and ban commands.
Have the correct lower bound on length of a snowflake for the converter.

1
changelog.d/modlog/.gitignore vendored
View File

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

1
changelog.d/mutes/.gitignore vendored
View File

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

1
changelog.d/permissions/.gitignore vendored
View File

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

1
changelog.d/permissions/3465.issue.rst
View File

@ -1 +0,0 @@
Fixes issue with licenseinfo not erroring out while modified with permissions setdefaultglobalrule and setdefaultserverrule.

1
changelog.d/reports/.gitignore vendored
View File

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

1
changelog.d/streams/.gitignore vendored
View File

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

1
changelog.d/streams/3237.enhance.rst
View File

@ -1 +0,0 @@
Added ``[p]streamset timer`` command, which can be used to control how often the cog checks for livestreams.

1
changelog.d/streams/3237.misc.rst
View File

@ -1 +0,0 @@
Changed the YouTube streams logic to use an RSS instead of the search endpoint, significantly reducing quota usage.

1
changelog.d/streams/3487.enhancement.rst
View File

@ -1 +0,0 @@
Use new Twitch API and Bearer tokens. Escape markdown and mass mentions for "streamer_name is live!" messages, and use humanize_number for every numbers.

1
changelog.d/trivia/.gitignore vendored
View File

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

1
changelog.d/warnings/.gitignore vendored
View File

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

2
changelog.d/warnings/2929.feature.rst
View File

@ -1,2 +0,0 @@
Added features to mod to be able to toggle warns being sent to both DM's and channel.
Added a command to set the channel the warns get sent to. (defaults to the channel the warn was issued in).

1
changelog.d/warnings/3515.misc.rst
View File

@ -1 +0,0 @@
Don't use `inspect.getsource` to check for ``is_owner`` check.

6
make.bat
View File

@ -34,12 +34,6 @@ goto syncenv
.\.venv\Scripts\python -m pip install -Ur .\tools\dev-requirements.txt
exit /B %ERRORLEVEL%
:checkchangelog
REM This should be written for windows at some point I guess.
REM If we can swith to powershell, it can make this much easier.
echo This doesn^'t do anything on windows ^(yet^)
exit /b 0
:help
echo Usage:
echo make ^<command^>

126
pyproject.toml
View File

@ -16,129 +16,3 @@
| dist
)/
'''
[tool.towncrier]
package = "redbot"
filename = "CHANGELOG.rst"
directory = "changelog.d"
issue_format = "`#{issue} <https://github.com/Cog-Creators/Red-DiscordBot/issues/{issue}>`_"
[[tool.towncrier.section]]
path = ""
name = "Core Bot Changes"
[[tool.towncrier.section]]
path = "admin"
name = "Admin"
[[tool.towncrier.section]]
path = "alias"
name = "Alias"
[[tool.towncrier.section]]
path = "audio"
name = "Audio"
[[tool.towncrier.section]]
path = "bank"
name = "Bank"
[[tool.towncrier.section]]
path = "cleanup"
name = "Cleanup"
[[tool.towncrier.section]]
path = "customcom"
name = "CustomCom"
[[tool.towncrier.section]]
path = "downloader"
name = "Downloader"
[[tool.towncrier.section]]
path = "economy"
name = "Economy"
[[tool.towncrier.section]]
path = "filter"
name = "Filter"
[[tool.towncrier.section]]
path = "general"
name = "General"
[[tool.towncrier.section]]
path = "image"
name = "Image"
[[tool.towncrier.section]]
path = "mod"
name = "Mod"
[[tool.towncrier.section]]
path = "modlog"
name = "ModLog"
[[tool.towncrier.section]]
path = "mutes"
name = "Mutes"
[[tool.towncrier.section]]
path = "permissions"
name = "Permissions"
[[tool.towncrier.section]]
path = "reports"
name = "Reports"
[[tool.towncrier.section]]
path = "streams"
name = "Streams"
[[tool.towncrier.section]]
path = "trivia"
name = "Trivia"
[[tool.towncrier.section]]
path = "warnings"
name = "Warnings"
[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking Changes"
showcontent = true
[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug Fixes"
showcontent = true
[[tool.towncrier.type]]
directory = "enhance"
name = "Enhancements"
showcontent = true
[[tool.towncrier.type]]
directory = "feature"
name = "New Feature"
showcontent = true
[[tool.towncrier.type]]
directory = "removal"
name = "Removals"
showcontent = true
[[tool.towncrier.type]]
directory = "misc"
name = "Miscellaneous changes"
showcontent = false
[[tool.towncrier.type]]
directory = "dep"
name = "Changes to dependencies"
showcontent = true
[[tool.towncrier.type]]
directory = "docs"
name = "Documentation Changes"
showcontent = true

1
setup.cfg
View File

@ -77,7 +77,6 @@ docs =
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
sphinxcontrib-trio==1.1.0
towncrier==19.2.0
urllib3==1.25.8
postgres =
asyncpg==0.20.1

19
tools/check_changelog_entries.sh
View File

@ -1,19 +0,0 @@
#!/usr/bin/env bash
# This can be run for other remotes than origin with the env vat `RED_REMOTE`
REMOTE="${RED_REMOTE:-origin}"
if [[ $(git diff "$REMOTE"/V3/develop) ]]; then
if [[ $(git diff "$REMOTE"/V3/develop -- changelog.d/) ]]; then
echo "Found changelog fragments..."
exit 0
else
echo "Error: No new changelog fragments!"
exit 1
fi
else
echo "No changes to need changelog for."
exit 0
fi

1
tools/primary_deps.ini
View File

@ -33,7 +33,6 @@ docs =
Sphinx
sphinx_rtd_theme
sphinxcontrib-trio
towncrier
postgres =
asyncpg
style =