From 9552d210f5c96cea89607a8dee24af3b39de352b Mon Sep 17 00:00:00 2001 From: jack1142 <6032823+jack1142@users.noreply.github.com> Date: Sat, 28 Mar 2020 02:46:15 +0100 Subject: [PATCH] Remove towncrier (#3661) --- .gitignore | 1 + .github/CONTRIBUTING.md => CONTRIBUTING.md | 39 ++----- Makefile | 5 - changelog.d/.gitignore | 1 - changelog.d/3256.dep.rst | 1 - changelog.d/3472.enhance.rst | 4 - changelog.d/3526.enhance.rst | 1 - changelog.d/admin/.gitignore | 1 - changelog.d/alias/.gitignore | 1 - changelog.d/audio/.gitignore | 1 - changelog.d/audio/3201.feature.1.rst | 1 - changelog.d/bank/.gitignore | 1 - changelog.d/cleanup/.gitignore | 1 - changelog.d/customcom/.gitignore | 1 - changelog.d/downloader/.gitignore | 1 - changelog.d/economy/.gitignore | 1 - changelog.d/economy/3438.bugfix.rst | 1 - changelog.d/filter/.gitignore | 1 - changelog.d/general/.gitignore | 1 - changelog.d/general/2382.enhancement.rst | 1 - changelog.d/image/.gitignore | 1 - changelog.d/mod/.gitignore | 1 - changelog.d/mod/3472.enhance.rst | 1 - changelog.d/mod/3523.bugfix.rst | 2 - changelog.d/modlog/.gitignore | 1 - changelog.d/mutes/.gitignore | 1 - changelog.d/permissions/.gitignore | 1 - changelog.d/permissions/3465.issue.rst | 1 - changelog.d/reports/.gitignore | 1 - changelog.d/streams/.gitignore | 1 - changelog.d/streams/3237.enhance.rst | 1 - changelog.d/streams/3237.misc.rst | 1 - changelog.d/streams/3487.enhancement.rst | 1 - changelog.d/trivia/.gitignore | 1 - changelog.d/warnings/.gitignore | 1 - changelog.d/warnings/2929.feature.rst | 2 - changelog.d/warnings/3515.misc.rst | 1 - make.bat | 6 - pyproject.toml | 126 --------------------- setup.cfg | 1 - tools/check_changelog_entries.sh | 19 ---- tools/primary_deps.ini | 1 - 42 files changed, 9 insertions(+), 228 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (89%) delete mode 100644 changelog.d/.gitignore delete mode 100644 changelog.d/3256.dep.rst delete mode 100644 changelog.d/3472.enhance.rst delete mode 100644 changelog.d/3526.enhance.rst delete mode 100644 changelog.d/admin/.gitignore delete mode 100644 changelog.d/alias/.gitignore delete mode 100644 changelog.d/audio/.gitignore delete mode 100644 changelog.d/audio/3201.feature.1.rst delete mode 100644 changelog.d/bank/.gitignore delete mode 100644 changelog.d/cleanup/.gitignore delete mode 100644 changelog.d/customcom/.gitignore delete mode 100644 changelog.d/downloader/.gitignore delete mode 100644 changelog.d/economy/.gitignore delete mode 100644 changelog.d/economy/3438.bugfix.rst delete mode 100644 changelog.d/filter/.gitignore delete mode 100644 changelog.d/general/.gitignore delete mode 100644 changelog.d/general/2382.enhancement.rst delete mode 100644 changelog.d/image/.gitignore delete mode 100644 changelog.d/mod/.gitignore delete mode 100644 changelog.d/mod/3472.enhance.rst delete mode 100644 changelog.d/mod/3523.bugfix.rst delete mode 100644 changelog.d/modlog/.gitignore delete mode 100644 changelog.d/mutes/.gitignore delete mode 100644 changelog.d/permissions/.gitignore delete mode 100644 changelog.d/permissions/3465.issue.rst delete mode 100644 changelog.d/reports/.gitignore delete mode 100644 changelog.d/streams/.gitignore delete mode 100644 changelog.d/streams/3237.enhance.rst delete mode 100644 changelog.d/streams/3237.misc.rst delete mode 100644 changelog.d/streams/3487.enhancement.rst delete mode 100644 changelog.d/trivia/.gitignore delete mode 100644 changelog.d/warnings/.gitignore delete mode 100644 changelog.d/warnings/2929.feature.rst delete mode 100644 changelog.d/warnings/3515.misc.rst delete mode 100644 tools/check_changelog_entries.sh diff --git a/.gitignore b/.gitignore index cae373df4..5e0aee25d 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 89% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index df00afdf2..7e637926e 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/Makefile b/Makefile index 1a1e996d1..9cd7d7e55 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/changelog.d/.gitignore b/changelog.d/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/3256.dep.rst b/changelog.d/3256.dep.rst deleted file mode 100644 index 554998fa1..000000000 --- a/changelog.d/3256.dep.rst +++ /dev/null @@ -1 +0,0 @@ -Use websockets 8.1 diff --git a/changelog.d/3472.enhance.rst b/changelog.d/3472.enhance.rst deleted file mode 100644 index 43dc1fe4d..000000000 --- a/changelog.d/3472.enhance.rst +++ /dev/null @@ -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. \ No newline at end of file diff --git a/changelog.d/3526.enhance.rst b/changelog.d/3526.enhance.rst deleted file mode 100644 index 15256eb6a..000000000 --- a/changelog.d/3526.enhance.rst +++ /dev/null @@ -1 +0,0 @@ -Show DeprecationWarning's diff --git a/changelog.d/admin/.gitignore b/changelog.d/admin/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/admin/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/alias/.gitignore b/changelog.d/alias/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/alias/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/audio/.gitignore b/changelog.d/audio/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/audio/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/audio/3201.feature.1.rst b/changelog.d/audio/3201.feature.1.rst deleted file mode 100644 index 7c5beb4ca..000000000 --- a/changelog.d/audio/3201.feature.1.rst +++ /dev/null @@ -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. \ No newline at end of file diff --git a/changelog.d/bank/.gitignore b/changelog.d/bank/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/bank/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/cleanup/.gitignore b/changelog.d/cleanup/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/cleanup/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/customcom/.gitignore b/changelog.d/customcom/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/customcom/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/downloader/.gitignore b/changelog.d/downloader/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/downloader/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/economy/.gitignore b/changelog.d/economy/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/economy/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/economy/3438.bugfix.rst b/changelog.d/economy/3438.bugfix.rst deleted file mode 100644 index 6e748956f..000000000 --- a/changelog.d/economy/3438.bugfix.rst +++ /dev/null @@ -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. \ No newline at end of file diff --git a/changelog.d/filter/.gitignore b/changelog.d/filter/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/filter/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/general/.gitignore b/changelog.d/general/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/general/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/general/2382.enhancement.rst b/changelog.d/general/2382.enhancement.rst deleted file mode 100644 index d36b53e06..000000000 --- a/changelog.d/general/2382.enhancement.rst +++ /dev/null @@ -1 +0,0 @@ -Show more details in [p]serverinfo command when using a toggle. diff --git a/changelog.d/image/.gitignore b/changelog.d/image/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/image/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/mod/.gitignore b/changelog.d/mod/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/mod/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/mod/3472.enhance.rst b/changelog.d/mod/3472.enhance.rst deleted file mode 100644 index 87dbf9954..000000000 --- a/changelog.d/mod/3472.enhance.rst +++ /dev/null @@ -1 +0,0 @@ -Move ignore commands and checks into core. \ No newline at end of file diff --git a/changelog.d/mod/3523.bugfix.rst b/changelog.d/mod/3523.bugfix.rst deleted file mode 100644 index e4bc1d9e2..000000000 --- a/changelog.d/mod/3523.bugfix.rst +++ /dev/null @@ -1,2 +0,0 @@ -Allow mentions in hackban and ban commands. -Have the correct lower bound on length of a snowflake for the converter. \ No newline at end of file diff --git a/changelog.d/modlog/.gitignore b/changelog.d/modlog/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/modlog/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/mutes/.gitignore b/changelog.d/mutes/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/mutes/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/permissions/.gitignore b/changelog.d/permissions/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/permissions/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/permissions/3465.issue.rst b/changelog.d/permissions/3465.issue.rst deleted file mode 100644 index 19a88a817..000000000 --- a/changelog.d/permissions/3465.issue.rst +++ /dev/null @@ -1 +0,0 @@ -Fixes issue with licenseinfo not erroring out while modified with permissions setdefaultglobalrule and setdefaultserverrule. \ No newline at end of file diff --git a/changelog.d/reports/.gitignore b/changelog.d/reports/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/reports/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/streams/.gitignore b/changelog.d/streams/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/streams/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/streams/3237.enhance.rst b/changelog.d/streams/3237.enhance.rst deleted file mode 100644 index f437043f9..000000000 --- a/changelog.d/streams/3237.enhance.rst +++ /dev/null @@ -1 +0,0 @@ -Added ``[p]streamset timer`` command, which can be used to control how often the cog checks for livestreams. \ No newline at end of file diff --git a/changelog.d/streams/3237.misc.rst b/changelog.d/streams/3237.misc.rst deleted file mode 100644 index b6c984c03..000000000 --- a/changelog.d/streams/3237.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Changed the YouTube streams logic to use an RSS instead of the search endpoint, significantly reducing quota usage. \ No newline at end of file diff --git a/changelog.d/streams/3487.enhancement.rst b/changelog.d/streams/3487.enhancement.rst deleted file mode 100644 index ccd5f6d94..000000000 --- a/changelog.d/streams/3487.enhancement.rst +++ /dev/null @@ -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. \ No newline at end of file diff --git a/changelog.d/trivia/.gitignore b/changelog.d/trivia/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/trivia/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/warnings/.gitignore b/changelog.d/warnings/.gitignore deleted file mode 100644 index b722e9e13..000000000 --- a/changelog.d/warnings/.gitignore +++ /dev/null @@ -1 +0,0 @@ -!.gitignore \ No newline at end of file diff --git a/changelog.d/warnings/2929.feature.rst b/changelog.d/warnings/2929.feature.rst deleted file mode 100644 index 0d2367e6a..000000000 --- a/changelog.d/warnings/2929.feature.rst +++ /dev/null @@ -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). diff --git a/changelog.d/warnings/3515.misc.rst b/changelog.d/warnings/3515.misc.rst deleted file mode 100644 index 197ee6641..000000000 --- a/changelog.d/warnings/3515.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Don't use `inspect.getsource` to check for ``is_owner`` check. diff --git a/make.bat b/make.bat index a02c1391e..428dd9bc0 100644 --- a/make.bat +++ b/make.bat @@ -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 ^ diff --git a/pyproject.toml b/pyproject.toml index f76eff550..fabe9bd5d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,129 +16,3 @@ | dist )/ ''' - -[tool.towncrier] - package = "redbot" - filename = "CHANGELOG.rst" - directory = "changelog.d" - issue_format = "`#{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 diff --git a/setup.cfg b/setup.cfg index 2ee2ca1c0..0dab0bd20 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 diff --git a/tools/check_changelog_entries.sh b/tools/check_changelog_entries.sh deleted file mode 100644 index 34da49ba1..000000000 --- a/tools/check_changelog_entries.sh +++ /dev/null @@ -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 diff --git a/tools/primary_deps.ini b/tools/primary_deps.ini index a942eb0c4..bf9aa0bb1 100644 --- a/tools/primary_deps.ini +++ b/tools/primary_deps.ini @@ -33,7 +33,6 @@ docs = Sphinx sphinx_rtd_theme sphinxcontrib-trio - towncrier postgres = asyncpg style =