Courageous Comets

courageous-comets/.devcontainer/Dockerfile

@@ -0,0 +1 @@
+FROM mcr.microsoft.com/vscode/devcontainers/base:debian

courageous-comets/.devcontainer/devcontainer.json

@@ -0,0 +1,85 @@
+{
+  "containerEnv": {
+    "BOT_CONFIG_PATH": "${containerWorkspaceFolder}/application.yaml",
+    "ENVIRONMENT": "development",
+    "HF_HOME": "${containerWorkspaceFolder}/hf_data",
+    "NLTK_DATA": "${containerWorkspaceFolder}/nltk_data",
+    "POETRY_VIRTUALENVS_CREATE": "false",
+    "REDIS_HOST": "localhost",
+    "REDIS_PASSWORD": "redis",
+    "REDIS_PORT": "6379",
+    "SOPS_AGE_KEY_FILE": "${containerWorkspaceFolder}/secrets/keys.txt"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "charliermarsh.ruff",
+        "DavidAnson.vscode-markdownlint",
+        "KnisterPeter.vscode-commitizen",
+        "tamasfe.even-better-toml",
+        "-ms-python.autopep8",
+        "esbenp.prettier-vscode"
+      ],
+      "settings": {
+        "[markdown]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff"
+        },
+        "editor.formatOnSave": true,
+        "editor.formatOnSaveMode": "file",
+        "files.exclude": {
+          "**/.pytest_cache": true,
+          "**/.ruff_cache": true,
+          "**/__pycache__": true
+        },
+        "files.insertFinalNewline": true,
+        "python.analysis.typeCheckingMode": "basic",
+        "python.testing.pytestArgs": [
+          "."
+        ],
+        "python.testing.pytestEnabled": true,
+        "python.testing.unittestEnabled": false
+      }
+    }
+  },
+  "dockerComposeFile": "docker-compose.yaml",
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/act:1": {},
+    "ghcr.io/devcontainers-contrib/features/apt-packages": {
+      "packages": "age"
+    },
+    "ghcr.io/devcontainers-contrib/features/poetry:2": {},
+    "ghcr.io/devcontainers-contrib/features/sops:1": {},
+    "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
+    "ghcr.io/devcontainers/features/python:1": {
+      "installTools": false,
+      "version": "3.12"
+    }
+  },
+  "forwardPorts": [
+    6379,
+    8000,
+    8001
+  ],
+  "name": "Courageous Comets \u2604\ufe0f",
+  "portsAttributes": {
+    "6379": {
+      "label": "Redis",
+      "onAutoForward": "silent"
+    },
+    "8000": {
+      "label": "MkDocs",
+      "onAutoForward": "notify"
+    },
+    "8001": {
+      "label": "RedisInsight",
+      "onAutoForward": "silent"
+    }
+  },
+  "postCreateCommand": "bash .devcontainer/postcreate.sh",
+  "service": "dev",
+  "updateContentCommand": "bash .devcontainer/updatecontent.sh",
+  "workspaceFolder": "/workspace"
+}

courageous-comets/.devcontainer/docker-compose.yaml

@@ -0,0 +1,24 @@
+services:
+
+  # This is the development container
+  dev:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      cache_from:
+        - ghcr.io/thijsfranck/courageous-comets-devcontainer
+    volumes:
+      - ..:/workspace
+    command: 'sleep infinity'
+
+  redis-stack:
+    image: redis/redis-stack:7.2.0-v11
+    environment:
+      REDIS_ARGS: "--requirepass redis"
+    volumes:
+      - redis-stack-data:/data
+    network_mode: service:dev
+    restart: unless-stopped
+
+volumes:
+  redis-stack-data:

courageous-comets/.devcontainer/postcreate.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Mark the git repository as safe
+git config --global --add safe.directory $PWD
+
+# Install pre-commit hooks
+poetry run pre-commit install
+
+# Generate a new secret key if one doesn't exist
+if [ ! -f secrets/keys.txt ]; then
+  echo
+  echo "Generating a new secret key. Share the following public key with the team:"
+  age-keygen -o secrets/keys.txt
+  echo
+fi

courageous-comets/.devcontainer/updatecontent.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Install or update dependencies
+poetry install

courageous-comets/.env.lock

@@ -0,0 +1,11 @@
+DISCORD_TOKEN=ENC[AES256_GCM,data:3tRB8k5Yv1VmwJAhG5Bkxv7/ylRBv1eqrXbouZ7jQNUJp+ztXrFBeNUIvI7xoyKCUBaIE/PcCkchbU/Osq9JeB5nI1RKRHC8,iv:jTQ6lPD6jjJ3MWOKKqdkiXXXnGH+CuaxogQ9MtxzOUg=,tag:C6oAqZ9Xgw8B5juWjBR42A==,type:str]
+sops_age__list_0__map_enc=-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSBCckZmcmVaMkFwZFB6TWtI\nVGw3YjI1d3FmNUlORFlvQ0tmQmpmanIrOHd3Ckw1dlNBZ25uQTczdm96UTM4VDRU\nYUFKMEl1citaVDZGbWhnUE9kaHByMG8KLS0tIDdyTmlJL0IzL3UvSHI0czNLZFpo\nT3JHT21oZmtvTzhyMFJlMXZML1FwY2cKRYz8DUTACEa+Kft3J1i/iN+wJXVCZrCJ\n1rtpDOx9Ys8GmK54bRQih8k5O2S6u7Eps2zLRWOmMTSQj4d2ZCkO1A==\n-----END AGE ENCRYPTED FILE-----\n
+sops_age__list_0__map_recipient=age1sgv2yduaugas4travt8tjctmxe0jyge5p0w6ufcfard5umwaxvss2na2ff
+sops_age__list_1__map_enc=-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSA5ZGNFNUNjaTNTQ0l5ekNI\nSjJUN1ZLWjdJYkx1UHpQbmhZMHFiOW1qNFFNCnZ4MkhPdWVxcThHUWE5c3FtOGxy\nVTdoeUJoQmtFZEhNSDhudzZib3RpUTQKLS0tIHI3TzdmYmNEZGhnRDRYaFVrTk9P\nWkhKWEhjWHZRVVBjN2FOZzFVUGR5Q1UKh/wkyRmeo4DLKk0yqVA0f1DfhOJpAPCw\nnrkvJ8trH19147od9tDlSQaZo8ipKK0nmijowU6rnS52FjU0hAQm0g==\n-----END AGE ENCRYPTED FILE-----\n
+sops_age__list_1__map_recipient=age1lhk7gg022hrfn6z85m2qdmudm8vql4vn90fuyaulvw99fqv8yctq4uh39k
+sops_age__list_2__map_enc=-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSBFVEJCQ2xDWE1Ed21icXJy\nMDBSY1E5aW50R01YeDEzcTV3Y1c1eFZpQ2dRCm5xNjhGWTVXR2tPcDBzNnd3bldE\nZXhPSDVGNXM5ZkEvaDFLVU1iUFEvR1EKLS0tIERKSEVJZit0cXhzcEJUNUJlV0h3\nS3B5QlB3SFZIVHJLQUlYNHErTGxuT0EKFCsTjivBASb4wnsTjZwEzzM+YDVWtClp\n/+rRuwHrPSKDwce1PaxyqhuG4/UH7StEk/mCkCLnsUqJyTachVzJGQ==\n-----END AGE ENCRYPTED FILE-----\n
+sops_age__list_2__map_recipient=age1u9a2890jjzd3qak5k9xnjngt4qjjvttwag2yjm9sctf6vuawpu2skzekyn
+sops_lastmodified=2024-07-18T20:35:27Z
+sops_mac=ENC[AES256_GCM,data:Y8e/+o6z3iDosEydIbz2dbPR160I5SqHTgxcQNHEgQqxPTd9MNxsg8Iz4sygTNlB5ByAFOPm6/EbrFreQ9/ChairtoLWEnyRBuBanFSpB0ZU8a6hLC4Y/0ZQ2YN53/OvuZjBfYaHEsrQxvRTTbY9sp1+6HzbUqMvmMKu6WKz2F4=,iv:jhiy7F8NMtfmv7fqqXNQyewHl4CJzCzEc2sgdNf715c=,tag:/KyvJ5oKtBUZXLNUPxfZpg==,type:str]
+sops_unencrypted_suffix=_unencrypted
+sops_version=3.9.0

courageous-comets/.github/workflows/build-devcontainer.yaml

@@ -0,0 +1,32 @@
+name: Build Devcontainer
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .devcontainer/**/*
+      - .github/workflows/build-devcontainer.yaml
+
+permissions: write-all
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pre-build devcontainer image
+        uses: devcontainers/ci@v0.3
+        with:
+          imageName: ghcr.io/thijsfranck/courageous-comets-devcontainer
+          cacheFrom: ghcr.io/thijsfranck/courageous-comets-devcontainer
+          push: always

courageous-comets/.github/workflows/ci.yaml

@@ -0,0 +1,68 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis/redis-stack:7.2.0-v11
+        ports:
+          - 6379:6379
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      BOT_CONFIG_PATH: ${{ github.workspace }}/application.yaml
+      DISCORD_TOKEN: ${{ secrets.DISCORD_TOKEN }}
+      NLTK_DATA: ${{ github.workspace }}/nltk_data
+      HF_HOME: ${{ github.workspace }}/hf_data
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up caching for NLTK_DATA
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.NLTK_DATA }}
+          key: ${{ runner.os }}-nltk-data-${{ hashFiles(env.BOT_CONFIG_PATH) }}
+          restore-keys: |
+            ${{ runner.os }}-nltk-data-
+
+      - name: Set up caching for HF_HOME
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.HF_HOME }}
+          key: ${{ runner.os }}-hf-data-${{ hashFiles(env.BOT_CONFIG_PATH) }}
+          restore-keys: |
+            ${{ runner.os }}-hf-data-
+
+      - name: Setup Python, Poetry and dependencies
+        uses: packetcoders/action-setup-cache-python-poetry@main
+        with:
+          python-version: 3.12
+          poetry-version: 1.8.3
+
+      - name: Update GITHUB_PATH
+        run: echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+        shell: bash
+
+      - name: Run pre-commit hooks
+        uses: pre-commit/action@v3.0.1
+
+      - name: Run tests
+        run: poetry run pytest
+        shell: bash

courageous-comets/.github/workflows/publish.yaml

@@ -0,0 +1,52 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - v*.*.*
+
+permissions: write-all
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Log in to the Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Python, Poetry and Dependencies
+        uses: packetcoders/action-setup-cache-python-poetry@main
+        with:
+          python-version: 3.12
+          poetry-version: 1.8.3
+
+      - name: Build the Application
+        run: poetry build -f wheel
+        shell: bash
+
+      - name: Build and Publish the Docker Image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ghcr.io/thijsfranck/courageous-comets:${{ github.ref_name }},ghcr.io/thijsfranck/courageous-comets:latest
+
+      - name: Set up Git user
+        uses: fregante/setup-git-user@v2.0.1
+
+      - name: Build documentation
+        run: bash docs/replace-token.sh "<APP_VERSION>" "${{ github.ref_name }}"
+
+      - name: Publish documentation
+        run: poetry run mike deploy -b public-docs --push --update-aliases ${{ github.ref_name }} latest
+        shell: bash