diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index bfa955d..1defbdb 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -13,7 +13,7 @@ jobs: env: BUILD_DATE: ${{ github.event.head_commit.timestamp }} IMAGE_NAME: hammy-mchamilton - REPO_OWNER: parttimelegend + REPO_OWNER: hamhangout steps: - name: Checkout code diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..cba4d50 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,7 @@ +*.md @HamHangOut/Documentation +docs/* @HamHangOut/Documentation +.github/workflows/* @HamHangOut/Github +.github/FUNDING.yml @HamHangOut/Admins +* @HamHangOut/Developers +*.py @HamHangOut/Python +requirements.txt @HamHangOut/Python diff --git a/LICENSE b/LICENSE index aa2fbac..cf0d3c1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Joshua Clarke and Antony Bailey +Copyright (c) 2024 Ham Hang Out Developers and Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.MD b/README.MD index 485321f..29c0c3b 100644 --- a/README.MD +++ b/README.MD @@ -1,5 +1,7 @@ # Hammy McHamilton Discord Quiz Bot +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) + This is a Discord bot written in Python that hosts a quiz game with questions and answers on from the RSGB Amateur Radio Examination questions list. The bot randomly selects questions from a predefined quiz data set and prompts users to answer them within a specified time limit. ![.... --- .-- / -.. --- . ... / .- / -... .- ... - .- .-. -.. --..-- / --- .-. .--. .... .- -. --..-- / ... --- -. / --- ..-. / .- / .-- .... --- .-. . / .- -. -.. / .- / ... -.-. --- - ... -- .- -. --..-- / -.. .-. --- .--. .--. . -.. / .. -. / - .... . / -- .. -.. -.. .-.. . / --- ..-. / .- / ..-. --- .-. --. --- - - . -. / ... .--. --- - / .. -. / - .... . / -.-. .- .-. .. -... -... . .- -. / -... -.-- / .--. .-. --- ...- .. -.. . -. -.-. . --..-- / .. -- .--. --- ...- . .-. .. ... .... . -.. --..-- / .. -. / ... --.- ..- .- .-.. --- .-. / --. .-. --- .-- / ..- .--. / - --- / -... . / .- / .... . .-. --- / .- -. -.. / .- / ... -.-. .... --- .-.. .- .-. ..--..](docs/hammy.jpg?raw=true "Hammy McHamilton") @@ -16,7 +18,7 @@ This is a Discord bot written in Python that hosts a quiz game with questions an 1. Clone this repository to your local machine: ```bash - git clone https://github.com/parttimelegend/hammy-mchamilton.git + git clone https://github.com/HamHangOut/hammy-mchamilton.git ``` 2. Navigate to the project directory: diff --git a/deploy/terraform/README.MD b/deploy/terraform/README.MD index db64b45..80dc562 100644 --- a/deploy/terraform/README.MD +++ b/deploy/terraform/README.MD @@ -32,15 +32,15 @@ No requirements. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [app\_name](#input\_app\_name) | n/a | `string` | `"hammy"` | no | -| [app\_service\_sku\_name](#input\_app\_service\_sku\_name) | n/a | `string` | `"P1v2"` | no | -| [container](#input\_container) | n/a | `string` | `"parttimelegend/hammy-mchamilton:latest"` | no | -| [container\_registry](#input\_container\_registry) | n/a | `string` | `"https://ghcr.io"` | no | -| [discord\_token](#input\_discord\_token) | n/a | `string` | n/a | yes | -| [environment](#input\_environment) | n/a | `string` | n/a | yes | -| [keyvault\_sku\_name](#input\_keyvault\_sku\_name) | n/a | `string` | `"standard"` | no | -| [location](#input\_location) | n/a | `string` | `"UK South"` | no | -| [os\_type](#input\_os\_type) | n/a | `string` | `"Linux"` | no | +| [app\_name](#input\_app\_name) | The app name to use. | `string` | `"hammy"` | no | +| [app\_service\_sku\_name](#input\_app\_service\_sku\_name) | The sku to use for the app service | `string` | `"P1v2"` | no | +| [container](#input\_container) | Container name | `string` | `"HamHangOut/hammy-mchamilton:latest"` | no | +| [container\_registry](#input\_container\_registry) | Container registry URL | `string` | `"https://ghcr.io"` | no | +| [discord\_token](#input\_discord\_token) | n/a | `string` | `"Discord oauth2 token. SENSITIVE."` | no | +| [environment](#input\_environment) | The environment to deploy this app service to e.g., dev, test, staging, prod. | `string` | n/a | yes | +| [keyvault\_sku\_name](#input\_keyvault\_sku\_name) | The SKU to use for the KeyVault | `string` | `"standard"` | no | +| [location](#input\_location) | The Azure location for deploying this this application to. | `string` | `"UK South"` | no | +| [os\_type](#input\_os\_type) | OS Type (Windows / Linux) | `string` | `"Linux"` | no | ## Outputs diff --git a/deploy/terraform/variables.tf b/deploy/terraform/variables.tf index 41d7dcf..ae0bd33 100644 --- a/deploy/terraform/variables.tf +++ b/deploy/terraform/variables.tf @@ -23,7 +23,7 @@ variable "app_name" { variable "container" { type = string - default = "parttimelegend/hammy-mchamilton:latest" + default = "HamHangOut/hammy-mchamilton:latest" description = "Container name" }