Merge branch 'main' into statusroles

Author: electron271

tux/cogs/moderation/roles.py renamed to .archive/roles.py

@@ -1,6 +1,20 @@
 .devcontainer/
 .env
-.git/
 .github/
 .venv/
 .vscode/
+.cache/
+__pycache__/
+*.pyc
+assets/
+.archive/
+docs/
+docs-build/
+site/
+.markdownlint.yaml
+.mise.toml
+.python-version
+.pre-commit-config.yaml
+.gitignore
+.cursorrules
+.editorconfig

tux/cogs/utility/snippets.py renamed to .archive/snippets.py

@@ -1,43 +1,69 @@
-#
-# Required
-#
+# Tux Environment Configuration (.env.example)
+# -------------------------------------------
+# Copy this file to .env and fill in the values.
+# Do NOT commit your actual .env file to version control.
 
-# If in production mode:
+# Core Requirements
+# -----------------
+# These variables are fundamental and required depending on the mode.
 
-# DEV=False
+# Database URLs (Required: one depending on mode)
+# The application uses DEV_DATABASE_URL when run with '--dev' flag,
+# and PROD_DATABASE_URL otherwise (production mode).
+DEV_DATABASE_URL=""
 PROD_DATABASE_URL=""
-PROD_TOKEN=""
 
-# If in development mode:
+# Bot Tokens (Required: one depending on mode)
+# The application uses DEV_BOT_TOKEN when run with '--dev' flag,
+# and PROD_BOT_TOKEN otherwise (production mode).
+DEV_BOT_TOKEN=""
+PROD_BOT_TOKEN=""
 
-# DEV=True
-DEV_DATABASE_URL=""
-DEV_TOKEN=""
+# Development Specific Settings
+# ---------------------------
+# These settings primarily affect development mode ('--dev').
+
+# Cogs to ignore during development (Optional, comma-separated)
+# Example: DEV_COG_IGNORE_LIST="somecog,anothercog"
+DEV_COG_IGNORE_LIST="rolecount,mail,git" # Default ignores ATL-specific cogs
+
+# Production Specific Settings
+# --------------------------
+# These settings primarily affect production mode (no '--dev' flag).
 
-#
-# Optional
-#
+# Cogs to ignore in production (Optional, comma-separated)
+# Example: PROD_COG_IGNORE_LIST="debugcog"
+PROD_COG_IGNORE_LIST="rolecount,mail,git" # Default ignores ATL-specific cogs
 
-INFLUXDB_TOKEN=""
-INFLUXDB_URL=""
-INFLUXDB_ORG=""
+# Optional Feature Configuration
+# ----------------------------
+# Fill these variables to enable optional integrations.
 
-SENTRY_URL=""
+# Sentry (Error Tracking)
+# SENTRY_URL=""
 
-PROD_COG_IGNORE_LIST="rolecount,mail" # These are ATL specific cogs that are not needed in Tux unless you are ATL
-DEV_COG_IGNORE_LIST=
+# InfluxDB (Metrics/Logging)
+# ------------------
 
-GITHUB_APP_ID=
-GITHUB_CLIENT_ID=""
-GITHUB_CLIENT_SECRET=""
-GITHUB_PUBLIC_KEY=""
-GITHUB_INSTALLATION_ID=
+# INFLUXDB_TOKEN=""
+# INFLUXDB_URL=""
+# INFLUXDB_ORG=""
 
-GITHUB_PRIVATE_KEY_BASE64=""
+# GitHub Integration
+# ------------------
+# These variables are used for the ATL GitHub integration that is is used for creating issues quickly.
+# You can safely ignore these until we have a proper way to guide using them multi guild/self hosted wise.
 
-GITHUB_REPO_URL=
-GITHUB_REPO_OWNER=
-GITHUB_REPO=
+# GITHUB_APP_ID=
+# GITHUB_CLIENT_ID=""
+# GITHUB_CLIENT_SECRET=""
+# GITHUB_PUBLIC_KEY=""
+# GITHUB_INSTALLATION_ID=
+# GITHUB_PRIVATE_KEY_BASE64="" # Base64 encoded private key
+# GITHUB_REPO_URL=
+# GITHUB_REPO_OWNER=
+# GITHUB_REPO=
 
-MAILCOW_API_KEY=
-MAILCOW_API_URL=
+# Mailcow Integration (Email related features)
+# MAILCOW_API_KEY=
+# MAILCOW_API_URL=

.cursorrules

@@ -1,5 +1,7 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "timezone": "America/New_York",
+  "schedule": ["* 0 * * 0"],
   "extends": [
     "config:recommended"
   ]

.dockerignore

@@ -1,42 +1,50 @@
-name: Create and Publish Docker Image CI
-
+name: "GHCR - Build and Push Docker Image"
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
 
 jobs:
-
   docker:
-
     runs-on: ubuntu-latest
     permissions:
       contents: read
       packages: write
 
     steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Fetch the full repository history including .git
+          
       - name: Docker meta
         id: meta
         uses: docker/metadata-action@v5
         with:
           images: |
-            ghcr.io/allthingslinux/tux            
+            ghcr.io/allthingslinux/tux
           tags: |
             type=raw,value=latest,enable={{is_default_branch}}
             type=ref,event=pr
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
+
       - name: Login to GHCR
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            BUILDKIT_CONTEXT_KEEP_GIT_DIR=1
+