Skip to content

Commit

Permalink
#281: Merge support (#284)
Browse files Browse the repository at this point in the history
  • Loading branch information
jf-06 authored Mar 1, 2024
1 parent 75bf28e commit 7f463ff
Show file tree
Hide file tree
Showing 27 changed files with 1,354 additions and 1 deletion.
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/blacklist_appeal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Blacklist Appeal
description: Request a blacklist appeal. File this if you would like to appeal a blacklist for yourself or a guild you own.
title: "[Appeal]: "
labels: ["kind: appeal", "status: backlogged", "status: needs-review"]
assignees: ["nikita-petko"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this blacklist appeal!
- type: checkboxes
attributes:
label: You have read the blacklist guidelines?
description: Please check the [guidelines](https://grid-bot.ops.vmminfra.net/moderation) to determine if your appeal conforms to them.
options:
- label: "I double checked the guidelines and my appeal conforms to them."
required: true
- type: checkboxes
attributes:
label: You haven't been blacklisted before?
description: If you have been blacklisted before, then don't file an appeal as you'll get declined.
options:
- label: "I double checked the blacklist and I haven't been blacklisted before."
required: true
- type: input
id: discord-user-id
attributes:
label: The ID of the Discord User you are appealing for. If you are appealing for a guild this must be the ID of the owner.
description: Please refer to the [Discord Helpcenter](https://support.discord.com/hc/en-us/articles/206346498) for more information on how to find the Discord ID of a user.
placeholder: ex. 819791451436482600
validations:
required: true
- type: input
id: date-blacklisted
attributes:
label: The date you were blacklisted.
description: You must provide the date you were blacklisted. As the moderation team will need to determine *why* you were blacklisted. In the format of `YYYY-MM-DD HH:MM:SS`.
placeholder: ex. 2020-01-01 00:00:00
validations:
required: true
- type: input
id: guild-id
attributes:
label: The ID of the guild you think you were blacklisted in or you are getting a blacklist revoked for.
description: Please refer to the [Discord Helpcenter](https://support.discord.com/hc/en-us/articles/206346498) for more information on how to find the ID of a guild.
placeholder: ex. 559083251805978644
validations:
required: true
- type: input
id: channel-id
attributes:
label: The ID of the channel you think you were blacklisted in. This does not apply if you are appealing guild blacklist.
description: Please refer to the [Discord Helpcenter](https://support.discord.com/hc/en-us/articles/206346498) for more information on how to find the ID of a channel.
placeholder: ex. 954168914273767484
validations:
required: false
- type: textarea
id: appeal-reason
attributes:
label: The reason you are appealing.
description: Minimum of 50 characters on why you are appealing.
placeholder: I am appealing because I was blacklisted for spamming...
validations:
required: true
- type: textarea
id: apology
attributes:
label: An apology for the moderation team.
description: Minimum of 100 characters apology towards the moderation team and the clients who use the bot.
placeholder: I am sorry for the spamming and I am trying to get this removed.
validations:
required: true
- type: textarea
id: images
attributes:
label: Images
description: Attach images to the appeal. This is optional if you have evidence to prove your innocence.
validations:
required: false
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Bug Report
description: File a bug report, use this if you have discovered a bug in production and wish the internal team to investigate.
title: "[Bug]: "
labels: ["kind: fix", "status: backlogged", "status: needs-review"]
assignees: ["nikita-petko"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Check if there is an existing issue or pull request.
description: Please check the [issues](https://github.com/mfdlabs/grid-bot/issues) to determine if your issue has already been filed.
options:
- label: "I double checked issues and couldn't find any duplicates."
required: true
- type: checkboxes
attributes:
label: This occurs on the latest version of the bot.
description: If this bug occurs on a previous version of the bot, please check this box. There will be a version string in the README.md that will correlate to a version that you can check on the bot.
options:
- label: I verified that the bot is running on the latest version.
required: true
- type: checkboxes
attributes:
label: Does this bug occur frequently?
description: If this bug occurs frequently, please tick this box.
options:
- label: This bug occurs frequently.
required: false
- type: textarea
id: description
attributes:
label: Description
description: A detailed explination of the bug.
placeholder: When rendering, it will throw an error.
validations:
required: true
- type: input
id: deployment-id
attributes:
label: The deployment ID of the bot.
description: This refers to the deployment ID of the bot, there will be a command that lets you retrieve this value (/support). Use this if it's version specific.
placeholder: ex. 2022.03.06-01.36.27_master_561a09f-net48-Release
validations:
required: false
- type: input
id: dates-of-occurrence
attributes:
label: The dates of occurrence of the bug.
description: This refers to the dates of occurrence of the bug. These can be on any time zone, but must include the year, month, day, hour, minute, and second (if possible). This accepts multiple dates, separated by commas.
placeholder: ex. 2022/03/06 01:36:27 UTC+1, 2022/03/06 01:37:28 UTC+1, 2022/03/06 01:38:11 UTC+1
validations:
required: false
- type: input
id: machine-id
attributes:
label: The hostname, Machine ID and IP of the machine
description: This refers to the hostname, Machine ID and IP of the machine, there will be a command that lets you retrieve this value (/support). This is optional, but is very helpful for debugging.
placeholder: ex. dapp181-dec.distrubuted.jfk01-us-east-01.mfdlabs.local, JFK01-DApp181, 10.128.29.28
validations:
required: false
- type: textarea
id: images
attributes:
label: Images
description: Attach images to the bug report. This is optional.
validations:
required: false
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Please provide steps to reproduce the bug. This is optional, but is highly recommended.
placeholder: >
1. Execute command /execute script script:BLAH BLAH
2. Paste this code in blah blah.
3. Magic!!
validations:
required: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: Discord Guild Invite
url: https://discord.gg/DURUeUcfar
about: Join this Guild if you want to talk directly to the owner of the bot.
- name: Discord Bot Invite
url: https://discord.com/api/oauth2/authorize?client_id=819791451436482600&permissions=2147798080&response_type=code&scope=bot%20applications.commands%20messages.read
about: If you wish to add the bot to your guilds, use this invite url to do so.
- name: Grid Bot Moderation Guidelines
url: https://grid-bot.ops.vmminfra.net/moderation
about: Please refer to here before opening Blacklist appeals.
- name: Grid Bot Terms of Service
url: https://grid-bot.ops.vmminfra.net/legal/tos
about: Please refer to here for the terms and conditions for using or integrating this bot within Discord.
- name: Grid Bot Privacy Policy
url: https://grid-bot.ops.vmminfra.net/legal/privacy-policy
about: Please refer to here for the information on how we use your data internally.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Feature Request
description: Request a new feature. File this if you would like to see a new feature added to the bot.
title: "[Feature]: "
labels: ["kind: feature", "kind: enhancement", "status: backlogged", "status: needs-review"]
assignees: ["nikita-petko"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this feature request!
- type: checkboxes
attributes:
label: Check if there is an existing issue or pull request
description: Please check the [issues](https://github.com/mfdlabs/grid-bot/issues) to determine if your feature request is already in the works or has already been requested.
options:
- label: "I double checked issues and couldn't find any duplicates."
required: true
- type: checkboxes
attributes:
label: Verify Feature Quality.
description: >
If your feature is actually worth being integrated. This includes things like:
- Does it work?
- Is it a good idea?
- Does it benefit the user?
- Will it generate traffic?
options:
- label: I verified the feature I requested, and it is worth being integrated.
required: true
- type: textarea
id: description
attributes:
label: Description
description: A detailed explaintion of the feature. Be as detailed as possible. Going from how the feature works to the benefits of the feature.
placeholder: It adds new code and stuff blah blah.
validations:
required: true
- type: textarea
id: images
attributes:
label: Images
description: Attach images to the feature request.
validations:
required: false
93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/security_vulnerabilty.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: Security Vulnerabilty Report
description: File a security vulnerability report, use this if you have discovered a security vulnerability and wish the internal team to investigate.
title: "[Vulnerability]: "
labels: ["kind: hotfix", "priority: key deliverable", "status: backlogged", "status: needs-review"]
assignees: ["nikita-petko"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this security vulnerability report! This will be marked with the label "key deliverable", which will email @mfdlabs/sec-ops, @mfdlabs/ops and @mfdlabs/grid-team
- type: checkboxes
attributes:
label: Check if there is an existing issue or pull request.
description: Please check the [issues](https://github.com/mfdlabs/grid-bot/issues) to determine if your vulnerability has already been filed.
options:
- label: "I double checked issues and couldn't find any duplicates."
required: true
- type: checkboxes
attributes:
label: This occurs on the latest version of the bot.
description: If this bug occurs on the latest version of the bot, please check this box. There will be a version string in the README.md that will correlate to a version that you can check on the bot.
options:
- label: I verified that this occurs on the latest version.
required: true
- type: checkboxes
attributes:
label: Have you read the Security Vulnerability Guidelines?
description: If you have read the [Security Vulnerability Guidelines](https://github.com/mfdlabs/grid-bot/blob/master/SECURITY.md), and this issue conforms to them, please check this box.
options:
- label: I have read the Security Vulnerability Guidelines.
required: true
- type: dropdown
id: severity
attributes:
label: Vulernability Severity
description: This refers to the severity of the vulnerability. This is required.
options:
- "Critical"
- "High"
- "Medium"
- "Low"
- "Invonvenience"
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: A brief explination of the vulnerability.
placeholder: ex. Public IP address is exposed.
validations:
required: true
- type: input
id: deployment-id
attributes:
label: The deployment ID of the bot.
description: This refers to the deployment ID of the bot, there will be a command that lets you retrieve this value (/support). Use this if it's version specific.
placeholder: ex. 2022.03.06-01.36.27_master_561a09f-net48-Release
validations:
required: false
- type: input
id: dates-of-occurrence
attributes:
label: The dates of occurrence of the vulnerability.
description: This refers to the dates of occurrence of the vulnerability. These can be on any time zone, but must include the year, month, day, hour, minute, and second (if possible). This accepts multiple dates, separated by commas.
placeholder: ex. 2022/03/06 01:36:27 UTC+1, 2022/03/06 01:37:28 UTC+1, 2022/03/06 01:38:11 UTC+1
validations:
required: false
- type: input
id: machine-id
attributes:
label: The hostname, Machine ID and IP of the machine
description: This refers to the hostname, Machine ID and IP of the machine, there will be a command that lets you retrieve this value (/support). This is optional, but is very helpful for debugging.
placeholder: ex. dapp181-dec.distrubuted.jfk01-us-east-01.mfdlabs.local, JFK01-DApp181, 10.128.29.28
validations:
required: false
- type: textarea
id: images
attributes:
label: Images
description: Attach images to the vulnerability report. This is optional, but is very helpful for debugging.
validations:
required: false
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Please provide steps to reproduce the bug. This is optional, but is highly recommended.
placeholder: >
1. Execute command /execute script script:BLAH BLAH
2. Paste this code in blah blah.
3. Magic!!
validations:
required: false
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
- "targets/**"
- "scripts/**"
- "nomad/**"
- ".github/workflows/**"
- ".github/workflows/build.yml"
- "Dockerfile"
- "Makefile"
- ".dockerignore"
Expand Down
42 changes: 42 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: MkDocs Deploy

on:
push:
branches:
- "master"
paths:
- "docs/**"
- ".github/workflows/docs.yml"
- "mkdocs.yml"
permissions:
contents: write

jobs:
mkdocs:
if: "!contains(toJSON(github.event.commits.*.message), '!#skip-build#!')"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.9.7"

- name: Install dependencies
run: |
pip install mkdocs-material mkdocs-minify-plugin
- name: Configure Git user
run: |
git config --local user.email "ops+grid-bot-gh@vmminfra.net"
git config --local user.name "grid-bot-gh"
- name: Deploy docs
run: |
mkdocs gh-deploy --force
env:
GITHUB_TOKEN: ${{ secrets.DEPLOYER_TOKEN }}
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ This repository contains code for the Grid Bot, this bot is designed to interact
- Rendering Roblox characters.
- Executing Luau code.

# Want to report an issue?

These issue reports apply to the currently deployed bot.

You can request the following:
1. [Bug Reports](https://github.com/mfdlabs/grid-bot/issues/new?assignees=nikita-petko&labels=kind:%20fix%2Cstatus:%20backlogged%2Cstatus:%20required-review&template=bug_report.yml&title=%5BBug%5D%3A+)
2. [Feature Requests](https://github.com/mfdlabs/grid-bot/issues/new?assignees=nikita-petko&labels=kind:%20feature%2Ckind:%20enhancement%2Cstatus:%20backlogged%2Cstatus:%20required-review&template=feature_request.yml&title=%5BFeature%5D%3A+)
3. [Security Issues](https://github.com/mfdlabs/grid-bot/issues/new?assignees=nikita-petko&labels=kind:%20hotfix%2Cpriority:%20key%20deliverable%2Cstatus:%20backlogged%2Cstatus:%20required-review&template=security_vulnerabilty.yml&title=%5BVulnerability%5D%3A+)
4. [Blacklist Appeals](https://github.com/mfdlabs/grid-bot/issues/new?assignees=nikita-petko&labels=kind:%20appeal%2Cstatus:%20backlogged%2Cstatus:%20required-review&template=blacklist_appeal.yml&title=%5BAppeal%5D%3A+)

These should be carried out with utmost professionalism and care, as otherwise they will be ignored, or will make it harder for the developer team to implement them.

# Notice

## Usage of Roblox, or any of its assets.
Expand Down
Loading

0 comments on commit 7f463ff

Please sign in to comment.