[3.2.0] Changelog (#3303)

* changelog

* refs
This commit is contained in:
Michael H 2020-01-09 12:59:55 -05:00 committed by GitHub
parent a9d3e271b0
commit d3e8d99bdf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
326 changed files with 596 additions and 429 deletions

View File

@ -1,2 +0,0 @@
Start the user guides covering cogs and the user interface of the bot. This
includes, for now, a "Getting started" guide.

View File

@ -1 +0,0 @@
Added documentation for PM2 support.

View File

@ -1 +0,0 @@
Add the option to modify the RPC port with the ``--rpc-port`` flag.

View File

@ -1 +0,0 @@
Updated linux install docs, adding sections for Fedora Linux, Debian/Raspbian Buster, and openSUSE.

View File

@ -1 +0,0 @@
Tests now use same event loop policy as Red's code.

View File

@ -1 +0,0 @@
Added functions to acquire locks on Config groups and values. These locks are acquired by default when calling a value as a context manager. See :meth:`Value.get_lock` for details

View File

@ -1 +0,0 @@
Added a config driver for PostgreSQL

View File

@ -1,32 +0,0 @@
Changes to the ``redbot.core.drivers`` package:
- The modules inside the ``redbot.core.drivers`` package no longer have the ``red_`` prefix in front of their names.
- All driver classes are now directly accessible as attributes to the ``redbot.core.drivers`` package.
- :func:`get_driver`'s signature has been changed.
- :func:`get_driver` can now use data manager to infer the backend type if it is not supplied as an argument.
- :func:`get_driver_class` has been added.
Changes to the :class:`BaseDriver` and :class:`JsonDriver` classes class:
- :meth:`BaseDriver.get_config_details` is an now abstract staticmethod.
- :meth:`BaseDriver.initialize` and :meth:`BaseDriver.teardown` are two new abstract coroutine classmethods.
- :meth:`BaseDriver.delete_all_data` is a new concrete (but overrideable) coroutine instance method.
- :meth:`BaseDriver.aiter_cogs` is a new abstract asynchronous iterator method.
- :meth:`BaseDriver.migrate_to` is a new concrete coroutine classmethod.
- :class:`JsonDriver` no longer requires the data path when constructed and will infer the data path from data manager.
Changes to the :class:`IdentifierData` class and :class:`ConfigCategory` enum:
- ``IdentifierData.custom_group_data`` has been replaced by :attr:`IdentifierData.primary_key_len`.
- :meth:`ConfigCategory.get_pkey_info` is a new classmethod.
Changes to the migration and backup system:
- All code in the ``redbot.setup`` script, excluding that regarding MongoV1, is now virtually backend-agnostic.
- All code in the ``[p]backup`` is now backend-agnostic.
- :func:`redbot.core.config.migrate` is a new coroutine function.
- All a new driver needs to do now to be compatible with migrations and backups is to implement the :class:`BaseDriver` ABC.
Enhancements to unit tests:
- New tox recipes have been added for testing against Mongo and Postgres backends. See the ``tox.ini`` file for clues on how to run them.

View File

@ -1,9 +0,0 @@
Adds methods to Config for accessing things by id without mocked objects
- Config.guild_from_id
- Config.user_from_id
- Config.role_from_id
- Config.channel_from_id
- Config.member_from_ids
- This one requires multiple ids, one for the guild, one for the user
- Consequence of discord's object model

View File

@ -1 +0,0 @@
New :func:`humanize_number` in :module:`redbot.core.utils.chat_formatting` function to convert numbers into text which respect locale.

View File

@ -1 +0,0 @@
New :func:`humanize_number` is used throughout the bot.

View File

@ -1,5 +0,0 @@
Added New commands to Economy
- ``[p]bank prune user`` - This will delete a user's bank account.
- ``[p]bank prune local`` - This will prune the bank of accounts from users no longer in the server.
- ``[p]bank prune global`` - This will prune the global bank of accounts from users who do not share any servers with the bot.

View File

@ -1,3 +0,0 @@
Added :func:`bank_prune` to :module:`redbot.core.bank`
- :func:`bank_prune` can be used to delete a specific user's bank account or remove all invalid bank accounts (For users who are not in the guild if bank is local or share servers with the bot if bank is global).

View File

@ -1,2 +0,0 @@
Added the function ``redbot.core.utils.chat_formatting.text_to_file`` to
prepare a long text to be send as a file.

View File

@ -1 +0,0 @@
Help properly hides disabled commands.

View File

@ -1 +0,0 @@
Red now uses towncrier for changelog generation

View File

@ -1 +0,0 @@
Slots now has a 62.5% expected payout and won't inflate economy when spammed.

View File

@ -1 +0,0 @@
Allow passing cls in the :func:`redbot.core.commands.group()` decorator

View File

@ -1 +0,0 @@
Create documentation covering what we consider a developer facing breaking change and guarantees regarding them.

View File

@ -1 +0,0 @@
[Tunnel] Added ``use_cached`` and ``images_only`` kwargs to `redbot.core.utils.Tunnel.files_from_attach`

View File

@ -1 +0,0 @@
Fixed remove_command error when trying to remove a non-existent command

View File

@ -1 +0,0 @@
``Command.can_see`` now works as intended for disabled commands

View File

@ -1 +0,0 @@
Red's Help Formatter is now considered to have a stable API.

View File

@ -1 +0,0 @@
Modlog casetypes no longer have an attribute for auditlog action type.

View File

@ -1 +0,0 @@
Modlog entries now show up properly without the mod cog loaded

View File

@ -1 +0,0 @@
Modlog no longer generates cases without being told to for actions the bot did.

View File

@ -1 +0,0 @@
Some generic modlog casetypes are now pre-registered for cog creator use

View File

@ -1 +0,0 @@
``redbot.core.modlog.get_next_case_number()`` has been removed.

View File

@ -1 +0,0 @@
Fixed error in `[p]reason` when setting the reason for a case without a moderator.

View File

@ -1 +0,0 @@
ModLog is now much faster at creating cases, especially in large servers.

View File

@ -1 +0,0 @@
Added :func:`redbot.core.modlog.get_latest_case` to fetch the case object for the most recent ModLog case.

View File

@ -1 +0,0 @@
Fixed user parameter being labeled as discord.TextChannel instead of discord.abc.User.

View File

@ -1 +0,0 @@
Updated towncrier info in contribution guidelines to include how to do a standalone PR.

View File

@ -1 +0,0 @@
Reworded virtual environment guide to make it sound less scary.

View File

@ -1 +0,0 @@
JSON config files are now stored without indentation, this is to reduce file size and increase performance of write operations.

View File

@ -1 +0,0 @@
Check the recipient balance before transferring and stop transfer if will go above the maximum allowed balance.

View File

@ -1 +0,0 @@
Fixed Requires docs inconsistencies

View File

@ -1 +0,0 @@
Removed :cons:`bank.MAX_BALANCE`, use :meth:`bank.get_max_balance()` from now.

View File

@ -1 +0,0 @@
`[p]bankset maxbal` can be used to set the maximum bank balance.

View File

@ -1 +0,0 @@
The ``set owner`` and ``set token`` commands have been removed in favor of managing server side.

View File

@ -1 +0,0 @@
Updated dependencies, most notably PyYAML, tqdm, uvloop and pymongo.

View File

@ -1 +0,0 @@
Setting the ``PYTHON`` env var whilst running ``make`` now allows you to specify which python executable to use.

View File

@ -1 +0,0 @@
Add `pip-wheel-metadata` folder to `.gitignore` file - pip creates it when installing Red in venv

View File

@ -1 +0,0 @@
The [p]invite command no longer errors when a user has the bot blocked or DMs disabled in the server.

View File

@ -1 +0,0 @@
Renamed two changelog files from fix to bugfix.

View File

@ -1 +0,0 @@
Fixed a typo in CONTRIBUTING.md.

View File

@ -1 +0,0 @@
Stop using `:` character in backup's filename - Windows doesn't accept it

View File

@ -1 +0,0 @@
``redbot-setup delete`` no longer errors about "unexpected keyword argument"

View File

@ -1 +0,0 @@
``redbot-setup delete`` no longer prompts about backup when user passes ``--no-prompt`` option

View File

@ -1 +0,0 @@
``--[no-]backup``, ``--[no-]drop-db`` and ``--[no-]remove-datapath`` in ``redbot-setup delete`` command are now on/off flags.

View File

@ -1 +0,0 @@
Confirmation prompts in ``redbot-setup`` now have default values for user convenience.

View File

@ -1 +0,0 @@
```redbot-setup delete`` now has the option to leave Red's data untouched on database backends.

View File

@ -1 +0,0 @@
[Core] Inviteset public and perms help string cleanup

View File

@ -1 +0,0 @@
Red takes less time to fetch cases, unban members, and list warnings.

View File

@ -1,3 +0,0 @@
Red no longer uses bot.fetch_user in core
- This is a 1/1s global ratelimit
- It really really really should be avoided.

View File

@ -1 +0,0 @@
Make embedset user only affect DM's

View File

@ -1,11 +0,0 @@
The main bot config is no longer directly accessible to cogs. New methods have been added for use where this is concerned.
New methods for this include
- ``bot.get_shared_api_tokens``
- ``bot.set_shared_api_tokens``
- ``bot.get_embed_color``
- ``bot.get_embed_colour``
- ``bot.get_admin_roles``
- ``bot.get_admin_role_ids``
- ``bot.get_mod_roles``
- ``bot.get_mod_role_ids``

View File

@ -1 +0,0 @@
Give friendly error when provided instance name doesn't exist.

View File

@ -1 +0,0 @@
Driver docs no longer show twice.

View File

@ -1 +0,0 @@
Reserves some command names for internal Red use. These are available programatically as ``redbot.core.commands.RESERVED_COMMAND_NAMES``

View File

@ -1 +0,0 @@
Fixed the help text and response of `[p]set usebotcolor` to accurately reflect what the command is doing.

View File

@ -1 +0,0 @@
Removes bot._counter, Makes a few more attrs private (cog_mgr, main_dir)

View File

@ -1,6 +0,0 @@
adds a few methods and classes replacing direct config access (which is no longer supported)
- ``redbot.core.Red.allowed_by_whitelist_blacklist``
- ``redbot.core.Red.get_valid_prefixes``
- ``redbot.core.Red.clear_shared_api_tokens``
- ``redbot.core.commands.help.HelpSettings``

View File

@ -1 +0,0 @@
Bot no longer types infinitely when command with cooldown is called within last second of cooldown.

View File

@ -1 +0,0 @@
Added more information about ``redbot.core.utils.humanize_timedelta`` into the docs

View File

@ -1 +0,0 @@
Updated the typing of ``redbot.core.utils.humanize_timedelta`` to be more accurate.

View File

@ -1 +0,0 @@
Add direct link to "Installing Red" section in "Installing using powershell and chocolatey"

View File

@ -1 +0,0 @@
Fixed a crash seen when calling economy commands in DM with a global bank.

View File

@ -1 +0,0 @@
Update Git PATH install (Windows), capitalise some words, don't mention to launcher

View File

@ -1 +0,0 @@
remove f-string usage in launcher to prevent our error handling from cauing an error.

View File

@ -1 +0,0 @@
Fixed MessagePredicate.greater and MessagePredicate.less allowing any valid int instead of only valid ints/floats that are greater/less than the given value.

View File

@ -1 +0,0 @@
Adds autostart documentation for Red users who installed it inside a virtual environment.

View File

@ -1 +0,0 @@
Uptime command works with uptimes of under a second

View File

@ -1 +0,0 @@
update some UI to include copyright

View File

@ -1 +0,0 @@
Add quotation marks to helpset tagline's response so two consecutive full stops don't appear

View File

@ -1 +0,0 @@
Fixes an issue with clearing rules in permissions

View File

@ -1 +0,0 @@
fixes a missing await from #2976

View File

@ -1 +0,0 @@
Update Cog Creation guide with a note regarding the Develop version as well as folder layout for local cogs

View File

@ -1 +0,0 @@
cog install will no longer error if a cog creator has an empty install message

View File

@ -1 +0,0 @@
Link to Getting started guide at the end of installation guides.

View File

@ -1 +0,0 @@
Lavalink will now be restarted after unexpected shutdown.

View File

@ -1 +0,0 @@
Add proper docstrings to enums that show in drivers docs.

View File

@ -1 +0,0 @@
Add 3rd-party lib folder to ``sys.path`` before loading cogs. This prevents issues with 3rd-party cogs failing to load without loaded Downloader due to unavailable requirements.

View File

@ -1 +0,0 @@
Bot now handles more things prior to connecting to discord to reduce issues with initial load

View File

@ -1 +0,0 @@
Escape track descriptions so that they do not break markdown.

View File

@ -1 +0,0 @@
``bot.send_filtered`` now returns the message that is sent.

View File

@ -1 +0,0 @@
Discord.py docs links will now always use docs for currently used version of discord.py.

View File

@ -1 +0,0 @@
Add ``|DPY_VERSION|`` substitution that will automatically get replaced by current discord.py version.

View File

@ -1 +0,0 @@
Add missing descriptions for function returns.

View File

@ -1 +0,0 @@
Bot will now properly send a message when the invoked command is guild-only.

View File

@ -1 +0,0 @@
Bot will now send a message when the invoked command is DM-only.

View File

@ -1 +0,0 @@
All ``y/n`` confirmations in cli commands are now unified.

View File

@ -1 +0,0 @@
Added ``redbot --edit`` cli flag that can be used to edit instance name, token, owner and datapath.

View File

@ -1 +0,0 @@
Always append 3rd-party lib folder to the end of ``sys.path`` to avoid shadowing Red's dependencies.

View File

@ -1 +0,0 @@
``bot.wait_until_ready`` should no longer be used during extension setup

View File

@ -1 +0,0 @@
Word using dev during install more strongly, to try to avoid end users using dev.

View File

@ -1 +0,0 @@
Do not overwrite the docs/prolog.txt file in conf.py.

View File

@ -1 +0,0 @@
Fix some typos and wording, add MS Azure to host list

View File

@ -1 +0,0 @@
adds a licenseinfo command

View File

@ -1 +0,0 @@
Removes the mongo driver.

Some files were not shown because too many files have changed in this diff Show More