Merge branch 'Cog-Creators:V3/develop' into V3/develop

CHANGES.rst

@@ -1,5 +1,65 @@
 .. Red changelogs
 
+Redbot 3.5.8 (2024-04-01)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Flame442`, :ghuser:`Jackenmen`, :ghuser:`Kreusada`, :ghuser:`TrustyJAID`
+
+Read before updating
+--------------------
+
+#. Server-wide mutes in the Mutes cog can no longer be performed using channel permissions (overrides). Instead, the cog will now use Discord's native server timeout functionality when a mute role is not set. Role mutes and channel-specific mutes are not affected.
+
+    Red 3.5.7 and lower allowed usage of channel permissions (overrides) for server-wide mutes when ``[p]muteset forcerole`` setting was explicitly disabled and no mute role was set for the server. This behavior is no longer available and now, when mute role is not set, server-wide mutes will be performed using Discord's native server timeouts.
+
+    If you were one of the few users that chose to use channel permissions (overrides) for server-wide mutes, please note that the existing server mutes will now be considered channel-specific mutes and can only be removed with ``[p]channelunmute`` (and will be automatically removed after timeout elapses, if they have one set). If you want to quickly remove all channel-specific mutes (that were previously server-wide mutes) for a user, you can use the hidden ``[p]forceunmute <user>`` command that has been provided to ease the migration.
+
+#. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
+
+    Red 3.5.8 uses a new Lavalink jar that you will need to manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.7.11%2Bred.2>`__.
+
+End-user changelog
+------------------
+
+Additions
+*********
+
+- |cool| **Cogs - Mutes** - Added support for Discord's native server timeouts. The cog will now use those when a mute role is not set or, when the new ``[p]timeout`` command is used (:issue:`5604`)
+- **Cogs - Trivia** - Trivia lists can now have a description as documented in :ref:`guide_trivia_list_creation` (:issue:`5897`)
+- |cool| **Cogs - Trivia** - Added ``[p]trivia info`` command for getting information about the specified Trivia list, including its setting overrides (:issue:`3978`, :issue:`5897`)
+
+Changes
+*******
+
+- **Core - Bot Commands** - The ``[p]addpath`` command will now detect potentially incorrect paths and prompt for confirmation (:issue:`6330`)
+- **Core - Bot Commands** - The ``[p]addpath`` command will now error out when the user tries adding a path that's part of the core path or instance's data path (:issue:`6330`)
+- **Core - Dependencies** - Red's dependencies have been bumped (:issue:`6333`)
+- **Cogs - Audio** - The cog will now log the reason for Lavalink.jar being re-downloaded (:issue:`6334`)
+- |cool| **Cogs - Mutes** - The ``[p]activemutes`` command will now use menus for pagination (:issue:`6266`)
+
+Removals
+********
+
+- **Cogs - Mutes** - Server-wide mutes can no longer be performed using channel permissions (overrides). Server timeouts or mute role can be used instead (:issue:`5604`)
+- **Cogs - Mutes** - The ``[p]muteset forcerole`` command and the setting it adjusted has been removed. Server timeouts will now be used for a server, if it has no mute role set (:issue:`5604`)
+
+Fixes
+*****
+
+- |cool| **Cogs - Audio** - Resolves recent issues where the wrong video was served for YT playback (:issue:`6337`, :issue:`6340`)
+- **Cogs - Audio** - Fixed Lavalink.jar downloading for RC and Red-specific versions (:issue:`6334`)
+
+Documentation changes
+---------------------
+
+Additions
+*********
+
+- |cool| Added install instructions for Amazon Linux 2023 (:issue:`6331`)
+
+----
+
 Redbot 3.5.7 (2024-03-24)
 =========================
 

docs/cog_guides/mutes.rst

@@ -145,28 +145,6 @@ If no time interval is provided this will be cleared.
 
 * ``[time]``: The length of time for a default mute.
 
-.. _mutes-command-muteset-forcerole:
-
-"""""""""""""""""
-muteset forcerole
-"""""""""""""""""
-
-.. note:: |owner-lock|
-
-**Syntax**
-
-.. code-block:: none
-
-    [p]muteset forcerole <true_or_false>
-
-**Description**
-
-Whether or not to force role only mutes on the bot.
-
-**Arguments**
-
-* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
-
 .. _mutes-command-muteset-makerole:
 
 """"""""""""""""
@@ -238,8 +216,8 @@ muteset role
 
 Sets the role to be applied when muting a user.
 
-If no role is setup the bot will attempt to mute a user by setting
-channel overwrites in all channels to prevent the user from sending messages.
+If no role is setup the bot will attempt to mute a user
+by utilizing server timeouts.
 
 .. Note:: 
 
@@ -362,6 +340,34 @@ Unmute a user in this channel (or in the parent of this thread).
 * ``<users...>``: A space separated list of usernames, ID's, or mentions.
 * ``[reason]``: The reason for the unmute.
 
+.. _mutes-command-timeout:
+
+^^^^^^^
+timeout
+^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]timeout <users...> [time_and_reason]
+
+**Description**
+
+Timeout users.
+
+Examples:
+
+* ``[p]timeout @member1 @member2 spam 5 hours``
+* ``[p]timeout @member1 3 days``
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or give an error if this hasn't been configured.
+
 .. _mutes-command-voicemute:
 
 ^^^^^^^^^
@@ -372,7 +378,7 @@ voicemute
 
 .. code-block:: none
 
-    [p]voicemute <users...> [reason]
+    [p]voicemute <users...> [time_and_reason]
 
 **Description**
 

docs/cog_guides/trivia.rst

@@ -334,6 +334,26 @@ will use all of the specified lists to select questions from.
 
 - ``<categories...>`` The category to play. Can be multiple.
 
+.. _trivia-command-trivia-info:
+
+^^^^^^^^^^^
+trivia info
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia info <category>
+
+**Description**
+
+Get information about a trivia category.
+
+**Arguments**
+
+* ``<category>``: The category to get the information for.
+
 .. _trivia-command-trivia-leaderboard:
 
 ^^^^^^^^^^^^^^^^^^

docs/guide_trivia_list_creation.rst

@@ -41,12 +41,33 @@ If there are multiple authors, we can separate them with commas.
 
     AUTHOR: Red, Rojo, Rouge
 
+-----------------
+Description Field
+-----------------
+
+We can also add an optional ``DESCRIPTION`` to our trivia list, which
+will show from the output of ``[p]trivia info <category>``. The
+description should indicate to the user what the trivia list is
+about and what kind of questions they can expect to face.
+
+For example, if you were writing a logo quiz trivia list, you could
+create a description like this:
+
+.. code-block:: yaml
+
+    AUTHOR: Kreusada
+    DESCRIPTION: >-
+      A quiz to test your logo knowledge to the limit. This trivia
+      will send image URLs and ask you to identify the company's name
+      from the logo that is sent.
+
 ---------------------
 Questions and Answers
 ---------------------
 
 Writing questions and answers is simple. Once you've finished your
-``AUTHOR`` field, you can move on to your questions just below.
+``AUTHOR`` field and ``DESCRIPTION`` field, you can move on to your questions
+just below.
 
 Questions should consist of at least one answer, with other
 possible answers included if necessary. You must put a colon at the end 
@@ -98,6 +119,7 @@ As you've added more questions, your file should look something like this:
 .. code-block:: yaml
 
     AUTHOR: Red
+    DESCRIPTION: A general quiz to test your knowledge.
     How many days are there in a regular year?:
     - 365
     - three hundred and sixty five

docs/install_guides/amazon-linux-2023.rst

@@ -0,0 +1,26 @@
+.. _install-amazon-linux-2023:
+
+===================================
+Installing Red on Amazon Linux 2023
+===================================
+
+.. include:: _includes/supported-arch-x64+aarch64.rst
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Amazon Linux 2023 has all required packages available in official repositories. Install
+them with dnf:
+
+.. prompt:: bash
+
+    sudo dnf -y install python3.11 python3.11-devel git java-17-amazon-corretto-headless @development nano
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv3.11.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/index.rst

@@ -15,6 +15,7 @@ we recommend **Ubuntu 22.04 LTS**.
    mac
    alma-linux-8
    alma-linux-9
+   amazon-linux-2023
    arch
    centos-7
    centos-stream-8

docs/version_guarantees.rst

@@ -57,6 +57,7 @@ macOS 13 (Ventura)                 x86-64, aarch64           ~2025-10
 macOS 14 (Sonoma)                  x86-64, aarch64           ~2026-10
 Alma Linux 8                       x86-64, aarch64           2029-05-31 (`How long will CloudLinux support AlmaLinux? <https://wiki.almalinux.org/FAQ.html#how-long-will-almalinux-be-supported>`__)
 Alma Linux 9                       x86-64, aarch64           2032-05-31
+Amazon Linux 2023                  x86-64, aarch64           2028-03-15 (`end-of-life <https://docs.aws.amazon.com/linux/al2023/release-notes/support-info-by-support-statement.html#support-info-by-support-statement-eol>`__)
 Arch Linux                         x86-64                    forever (support is only provided for an up-to-date system)
 CentOS 7                           x86-64, aarch64           2024-06-30 (`end of Maintenance Updates <https://wiki.centos.org/About/Product>`__)
 CentOS Stream 8                    x86-64, aarch64           2024-05-31 (`end of Maintenance Updates <https://wiki.centos.org/About/Product>`__)

redbot/__init__.py

@@ -339,7 +339,7 @@ def _early_init():
 
 
 # This is bumped automatically by release workflow (`.github/workflows/scripts/bump_version.py`)
-_VERSION = "3.5.8.dev1"
+_VERSION = "3.5.9.dev1"
 
 __version__, version_info = VersionInfo._get_version()