Merge branch 'main' into vgs-main

Author: MattyTheHacker

.github/workflows/check-build-deploy.yaml

@@ -15,7 +15,7 @@ jobs:
             - uses: actions/checkout@v5
 
             - name: Install uv
-              uses: astral-sh/setup-uv@v6
+              uses: astral-sh/setup-uv@v7
               with:
                 enable-cache: true
 
@@ -39,7 +39,7 @@ jobs:
                 python-version-file: .python-version
 
             - name: Install uv
-              uses: astral-sh/setup-uv@v6
+              uses: astral-sh/setup-uv@v7
               with:
                 enable-cache: true
 
@@ -75,7 +75,7 @@ jobs:
                 python-version-file: .python-version
 
             - name: Install uv
-              uses: astral-sh/setup-uv@v6
+              uses: astral-sh/setup-uv@v7
               with:
                 enable-cache: true
 
@@ -125,15 +125,15 @@ jobs:
                 python-version-file: .python-version
 
             - name: Install uv
-              uses: astral-sh/setup-uv@v6
+              uses: astral-sh/setup-uv@v7
               with:
                 enable-cache: true
 
-            - name: Install CCFT-PyMarkdown From Locked Dependencies
+            - name: Install PyMarkdown From Locked Dependencies
               run: uv sync --only-group lint-format
 
             - name: Run PyMarkdown scan
-              run: uv run -- ccft-pymarkdown scan-all
+              run: uv run -- pymarkdown scan .
 
     pytest:
         needs: [uv-check]
@@ -154,7 +154,7 @@ jobs:
                 python-version-file: .python-version
 
             - name: Install uv
-              uses: astral-sh/setup-uv@v6
+              uses: astral-sh/setup-uv@v7
               with:
                 enable-cache: true
 
@@ -202,7 +202,7 @@ jobs:
                 python-version-file: .python-version
 
             - name: Install uv
-              uses: astral-sh/setup-uv@v6
+              uses: astral-sh/setup-uv@v7
               with:
                 enable-cache: true
 
@@ -241,7 +241,7 @@ jobs:
 
         steps:
             - name: Log in to the Container registry
-              uses: docker/login-action@v3.5.0
+              uses: docker/login-action@v3.6.0
               with:
                 registry: ${{env.REGISTRY}}
                 username: ${{github.actor}}

.github/workflows/prevent-migrations-deletion.yaml

@@ -13,7 +13,7 @@ jobs:
 
         steps:
             - name: Prevent migrations files being changed or deleted
-              uses: xalvarez/prevent-file-change-action@v2.0.0
+              uses: xalvarez/prevent-file-change-action@v3.0.0
               with:
                 githubToken: ${{ secrets.GITHUB_TOKEN }}
                 pattern: '.*\/db\/.+\/migrations\/\d{4}\w*\.py$'

.pre-commit-config.yaml

@@ -6,19 +6,19 @@ default_language_version:
 
 repos:
     - repo: https://github.com/hadolint/hadolint
-      rev: v2.13.1
+      rev: v2.14.0
       hooks:
         - id: hadolint-docker
 
     - repo: https://github.com/renovatebot/pre-commit-hooks
-      rev: 41.98.4
+      rev: 41.154.1
       hooks:
         - id: renovate-config-validator
           args: [--strict]
           stages: [manual]
 
     - repo: https://github.com/python-jsonschema/check-jsonschema
-      rev: 0.33.3
+      rev: 0.34.1
       hooks:
         - id: check-github-workflows
 
@@ -74,20 +74,23 @@ repos:
           stages: [manual]
 
     - repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.12.12
+      rev: v0.14.1
       hooks:
         - id: ruff
           args: [--fix]
 
         - id: ruff-format
 
     - repo: https://github.com/astral-sh/uv-pre-commit
-      rev: 0.8.15
+      rev: 0.9.4
       hooks:
         - id: uv-lock
           always_run: true
 
     - repo: https://github.com/google/yamlfmt
-      rev: v0.17.2
+      rev: v0.19.0
       hooks:
         - id: yamlfmt
+          entry: yamlfmt
+          types: [yaml]
+          pass_filenames: true

CONTRIBUTING.md

@@ -24,7 +24,7 @@ Additionally, linked below are some helpful resources:
 If you are new to contributing to open-source projects on GitHub, the general workflow is as follows:
 
 1. [Fork](https://w3schools.com/git/git_remote_fork.asp) this [repository](https://phoenixnap.com/kb/what-is-a-git-repository#ftoc-heading-1) and [clone](https://w3schools.com/git/git_clone.asp) it
-2. Create a [branch](https://w3schools.com/git/git_remote_branch.asp) off main
+2. Create a [branch](https://w3schools.com/git/git_remote_branch.asp) from `main`
 3. Make your changes and [commit](https://w3schools.com/git/git_commit.asp) them
 4. [Push](https://w3schools.com/git/git_push_to_remote.asp) your local [branch](https://w3schools.com/git/git_remote_branch.asp) to your remote fork
 5. Open a new [pull request on GitHub](https://w3schools.com/git/git_remote_send_pull_request.asp)
@@ -44,20 +44,20 @@ If you find an issue with TeX-Bot, the best place to report it is through the is
 If you are looking for issues to contribute code to, it's a good idea to look at the [issues labelled "good-first-issue"](https://github.com/CSSUoB/TeX-Bot-Py-V2/issues?q=label%3A%22good+first+issue%22)!
 
 When submitting an issue, please be as descriptive as possible.
-If you are submitting a bug report, please include the steps to reproduce the bug, and the environment it is in.
+If you are submitting a bug report, please include the steps to reproduce the bug and the environment it is in.
 If you are submitting a feature request, please include the steps to implement the feature.
 
 ## Repository Structure
 
 ### Top level files
 
 * [`main.py`](main.py): is the main entrypoint to instantiate the [`Bot` object](https://docs.pycord.dev/stable/api/clients.html#discord.Bot) & run it
-* [`exceptions.py`](exceptions.py): contains common [exception](https://docs.python.org/3/tutorial/errors) subclasses that may be raised when certain errors occur
 * [`config.py`](config.py): retrieves the [environment variables](README.md#setting-environment-variables) & populates the correct values into the `settings` object
 
 ### Other significant directories
 
 * [`cogs/`](cogs): contains all the [cogs](https://guide.pycord.dev/popular-topics/cogs) within this project, see [below](#cogs) for more information
+* [`exceptions/`](exceptions): contains common [exception](https://docs.python.org/3/tutorial/errors) subclasses that may be raised when certain errors occur
 * [`utils/`](utils): contains common utility classes & functions used by the top-level modules & cogs
 * [`db/core/models/`](db/core/models): contains all the [database ORM models](https://docs.djangoproject.com/en/stable/topics/db/models) to interact with storing information longer-term (between individual command events)
 * [`tests/`](tests): contains the complete test suite for this project, based on the [Pytest framework](https://pytest.org)
@@ -68,8 +68,8 @@ If you are submitting a feature request, please include the steps to implement t
 They combine related [listeners](https://guide.pycord.dev/getting-started/more-features#event-handlers) and [commands](https://guide.pycord.dev/category/application-commands) (each as individual methods) into one class.
 There are separate cog files for each activity, and one [`__init__.py`](cogs/__init__.py) file which instantiates them all:
 
-<!--- pyml disable-next-line no-emphasis-as-heading-->
-*For more information about the purpose of each cog, please look at the documentation within the files themselves*
+> [!IMPORTANT]
+> For more information about the purpose of each cog, please look at the documentation within the files themselves
 
 * [`cogs/__init__.py`](cogs/__init__.py): instantiates all the cog classes within this directory
 
@@ -92,16 +92,16 @@ There are separate cog files for each activity, and one [`__init__.py`](cogs/__i
 * [`cogs/remind_me.py`](cogs/remind_me.py): cogs to ask TeX-Bot to send a reminder message at a later date
 
 * [`cogs/send_get_roles_reminders.py`](cogs/send_get_roles_reminders.py): cogs relating to sending reminders, to Discord members, about opt-in roles.
-(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met, to execute this task)
+(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met to execute this task)
 
 * [`cogs/send_introduction_reminders.py`](cogs/send_introduction_reminders.py): cogs relating to sending reminders, to Discord members, about introducing themselves.
-(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met, to execute this task)
+(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met to execute this task)
 
 * [`cogs/source.py`](cogs/source.py): cogs for displaying information about the source-code of this project
 
 * [`cogs/startup.py`](cogs/startup.py): cogs for startup & bot initialisation
 
-* [`cogs/stats.py`](cogs/stats.py): cogs for displaying stats about your group's Discord guild, as well as its channels & Discord members
+* [`cogs/stats/`](cogs/stats): cogs for displaying stats about your group's Discord guild, as well as its channels & Discord members
 
 * [`cogs/strike.py`](cogs/strike.py): cogs for applying moderation actions to Discord members
 
@@ -159,20 +159,15 @@ It can be run with the following command:
 uv run mypy .
 ```
 
-Although there is [a PyCharm plugin](https://github.com/leinardi/mypy-pycharm#mypy-pycharm) to provide GUI control & inline warnings for [mypy](https://mypy-lang.org), it has been rather temperamental recently.
-So it is suggested to avoid using it, and run [mypy](https://mypy-lang.org) from the command-line instead.
-
 #### PyMarkdown
 
 [PyMarkdown](https://github.com/jackdewinter/pymarkdown) is a static analysis [Markdown](https://markdownguide.org/getting-started#what-is-markdown) [linter](https://wikipedia.org/wiki/Lint_(software)), which will alert you to possible formatting mistakes in your [MarkDown](https://markdownguide.org/getting-started#what-is-markdown) files.
 It can be run with the following command:
 
 ```shell
-uv run ccft-pymarkdown scan-all --with-git
+uv run pymarkdown scan .
 ```
 
-This command includes the removal of custom-formatted tables. See the [CCFT-PyMarkdown tool](https://github.com/CarrotManMatt/CCFT-PyMarkdown) for more information on linting Markdown files that contain custom-formatted tables.
-
 ### Git Commit Messages
 
 Commit messages should be written in the imperative present tense. For example, "Fix bug #1".
@@ -205,7 +200,7 @@ Please note that any contributions you make will be made under the terms of the
 
 ## Guidance
 
-We aim to get more people involved with our projects, and help build members' confidence in using git and contributing to open-source.
+We aim to get more people involved with our projects and help build members' confidence in using git and contributing to open-source.
 If you see an error, we encourage you to **be bold** and fix it yourself, rather than just raising an issue.
 If you are stuck, need help, or have a question, the best place to ask is on our Discord.
 

README.md

@@ -142,7 +142,6 @@ uv sync
 > [!TIP]
 > Syncing the dependencies is not required. uv performs this automatically every time the `uv run` command is used
 
-
 ### Creating Your [Bot](https://discord.com/developers/docs/topics/oauth2#bot-vs-user-accounts)
 
 A full guide on how to create your bot's account can be found [here; on Pycord's wiki](https://docs.pycord.dev/en/stable/discord.html).
@@ -170,7 +169,7 @@ You'll also need to set a number of [environment variables](https://wikipedia.or
 * `SU_PLATFORM_ACCESS_COOKIE`: The SU platform [access session cookie](https://wikipedia.org/wiki/HTTP_cookie#Session_cookie).
   * This [session cookie](https://wikipedia.org/wiki/HTTP_cookie#Session_cookie) will [authenticate](https://wikipedia.org/wiki/Authentication) TeX-Bot to view your group's members list on the SU platform, as if it were [logged in to the website](https://wikipedia.org/wiki/Login_session) as a Committee member.
   * This can be [extracted from your web-browser](https://wikihow.com/View-Cookies), after logging in to view your members list yourself.
-    It will most likely be listed as a [cookie](https://wikipedia.org/wiki/HTTP_cookie) named [`.ASPXAUTH`](https://stackoverflow.com/a/424061/14403974).
+    It will most likely be listed as a [cookie](https://wikipedia.org/wiki/HTTP_cookie) named `.AspNet.SharedCookie`.
   * If you wish to test TeX-Bot with the SU platform-access disabled, a dummy value of 128 `0` characters can be used.
     Note that this will cause many commands and scheduled tasks to fail when they are used at runtime.
 

cogs/add_users_to_threads_and_channels.py

@@ -167,7 +167,7 @@ async def add_users_or_roles_with_ping(
     @capture_guild_does_not_exist_error
     async def on_thread_create(self, thread: discord.Thread) -> None:
         """Add users to a thread when it is created."""
-        # NOTE: Shortcut accessors are placed at the top of the function, so that the exceptions they raise are displayed before any further errors may be sent
+        # NOTE: Shortcut accessors are placed at the top of the function so that the exceptions they raise are displayed before any further errors may be sent
         committee_role: discord.Role = await self.bot.committee_role
         committee_elect_role: discord.Role = await self.bot.committee_elect_role
 
@@ -183,18 +183,18 @@ async def on_thread_create(self, thread: discord.Thread) -> None:
             users_or_roles=(committee_role, committee_elect_role), channel_or_thread=thread
         )
 
-    @discord.slash_command(  # type: ignore[no-untyped-call, misc]
+    @discord.slash_command(
         name="add-users-to-channel", description="Adds selected users to a channel or thread."
     )
-    @discord.option(  # type: ignore[no-untyped-call, misc]
+    @discord.option(
         name="user",
         description="The user to add to the channel.",
         input_type=str,
-        autocomplete=discord.utils.basic_autocomplete(autocomplete_get_members),  # type: ignore[arg-type]
+        autocomplete=discord.utils.basic_autocomplete(autocomplete_get_members),
         required=True,
         parameter_name="user_id_str",
     )
-    @discord.option(  # type: ignore[no-untyped-call, misc]
+    @discord.option(
         name="silent",
         description="Whether the users being added should be pinged or not.",
         input_type=bool,
@@ -203,7 +203,7 @@ async def on_thread_create(self, thread: discord.Thread) -> None:
     )
     @CommandChecks.check_interaction_user_has_committee_role
     @CommandChecks.check_interaction_user_in_main_guild
-    async def add_user_to_channel(  # type: ignore[misc]
+    async def add_user_to_channel(
         self,
         ctx: "TeXBotApplicationContext",
         user_id_str: str,
@@ -237,19 +237,19 @@ async def add_user_to_channel(  # type: ignore[misc]
             ephemeral=True,
         )
 
-    @discord.slash_command(  # type: ignore[no-untyped-call, misc]
+    @discord.slash_command(
         name="add-role-to-channel",
         description="Adds the selected role and it's users to a channel or thread.",
     )
-    @discord.option(  # type: ignore[no-untyped-call, misc]
+    @discord.option(
         name="role",
         description="The role to add to the channel.",
         input_type=str,
-        autocomplete=discord.utils.basic_autocomplete(autocomplete_get_roles),  # type: ignore[arg-type]
+        autocomplete=discord.utils.basic_autocomplete(autocomplete_get_roles),
         required=True,
         parameter_name="role_id_str",
     )
-    @discord.option(  # type: ignore[no-untyped-call, misc]
+    @discord.option(
         name="silent",
         description="Whether the users being added should be pinged or not.",
         input_type=bool,
@@ -258,7 +258,7 @@ async def add_user_to_channel(  # type: ignore[misc]
     )
     @CommandChecks.check_interaction_user_has_committee_role
     @CommandChecks.check_interaction_user_in_main_guild
-    async def add_role_to_channel(  # type: ignore[misc]
+    async def add_role_to_channel(
         self,
         ctx: "TeXBotApplicationContext",
         role_id_str: str,