Merge 1d149db into 7347f59

.github/workflows/news.yml

@@ -0,0 +1,32 @@
+name: Check for a news entry
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled, unlabeled, reopened]
+
+jobs:
+  check-news:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks out the repository in the current folder.
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Set up the right version of Python
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+
+      # Install the required dependencies for using the feature, we aren't using cache here
+      # as the number is relatively small and having cache would be complete redundancy.
+      - name: Install dependencies using pip
+        run: |
+          pip install tomli requests
+
+      # Run the script for checking if there is a news entry for the current PR
+      - name: Check for a news entry in the news/next
+        run: |
+          python -m scripts.news.check_news_workflow ${{ github.event.pull_request.number }}

.gitignore

@@ -138,6 +138,7 @@ logs
 
 # Configuration
 *config.toml
+!scripts/news/config.toml
 
 # Custom docker compose override
 docker-compose.override.yml

docs/.requirements.txt

@@ -3,5 +3,5 @@
 # we have to declare our dependencies here
 
 mkdocs==1.2.3
-mkdocs-material==7.2.6
+mkdocs-material==7.3.6
 mkdocs-markdownextradata-plugin==0.1.9

news/latest.md

@@ -0,0 +1,67 @@
+## 0.2.0 (2021-09-29)
+
+---
+
+### Features
+
+- Interaction Paginator that uses discord buttons (#50)
+- docker-compose.yml (#13)
+    - Running the bot after configuring the env vars is now as simple as `docker-compose up`
+- Automatic docker image creation: `ghcr.io/discord-modmail/modmail` (#19)
+- Dockerfile support for all supported hosting providers. (#58)
+- Errors no longer happen silently and notify the user when they make a mistake. (#77)
+
+### Improvements
+
+- Refactored bot creation and bot running (#56)
+    - Running the bot is still the same method, but it loads extensions and plugins now.
+    - `bot.start()` can also be used if already in a running event loop. Keep in mind using it will require
+        handling loop errors, as run() does this automatically.
+
+### Internal
+
+- Code style: two blank lines after imports instead of one. (#70)
+
+
+## 0.1.0 (2021-08-13)
+
+---
+
+### Feature
+
+- Bot modes to determine behavior. Multiple can be applied at once. (#43)
+    - `PROD`: the default mode, no dev extensions or dev plugins load
+    - `DEVELOP`: the bot developer mode, most useful for people adding features to modmail
+- Enables the extension_manager extension.
+    - `PLUGIN_DEV`: the plugin developer mode, useful for enabling plugin specific features
+    - This is not used yet.
+- Extension loading system (#43)
+    - scans for extensions in the `modmail/extensions` folder and loads them if they are of the right format.
+    - all extensions must be loadable as a module, which means they must have `__init__.py` files in their directories.
+- Plugin loading system (#43)
+    - scans for plugins in the `modmail/plugins` folder and loads them.
+    - Unlike extensions, plugins and their respective folders do not need to have `__init__.py` files and are allowed to be symlinks.
+- Extension management commands (#43)
+    - load, reload, unload, list, refresh commands for dealing with extensions
+    - Run the `ext` command for more details when bot is in `DEVELOP` mode.
+- Plugin management commands (#43)
+    - load, reload, unload, list, refresh commands for dealing with plugins
+    - Run the `plugins` command for more details.
+- Extension metadata (#43)
+  - used to determine if a cog should load or not depending on the bot mode
+- Plugin helper file (#43)
+    - `modmail/plugin_helpers.py` contains several helpers for making plugins
+        - `PluginCog`
+        - `ModmailBot`, imported from `modmail.bot`
+        - `ModmailLogger`, imported from `modmail.log`
+- Meta Cog (#43)
+    - **NOTE**: The commands in this cog are not stabilized yet and should not be relied upon.
+    - Prefix command for getting the set prefix. Most useful by mentioning the bot.
+    - Uptime command which tells the end user how long the bot has been online.
+    - Ping command to see the bot latency.
+- Guide on how to contribute to modmail, see \[CONTRIBUTING.md\] <!-- #TODO: Make this a link -->
+- Start a Changelog
+
+### Bugfix
+
+- Make the bot `http_session` within an event loop.

news/next/README.md

@@ -0,0 +1 @@
+All your changelogs for upcoming release!

news/next/feature/2021-12-14.pr-119.md

@@ -0,0 +1,2 @@
+
+Officially support python 3.10

news/next/feature/2021-12-14.pr-121.md

@@ -0,0 +1,2 @@
+
+Officially support windows and macos

news/next/feature/2021-12-14.pr-71.md

@@ -0,0 +1,2 @@
+
+Added Dispatcher system, although it is not hooked into important features like thread creation yet.

news/next/feature/2021-12-14.pr-89.md

@@ -0,0 +1,2 @@
+
+Add a custom changelogger, inspired from the one at python/cpython

news/next/improvement/2021-12-14.pr-78.md

@@ -0,0 +1,2 @@
+
+Embedified the meta commands so they have a nicer UI