chore: update .github files

This commit is contained in:
2024-12-01 09:33:20 -07:00
parent 83717f0bdc
commit f1d2f8b468
7 changed files with 380 additions and 0 deletions

10
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1,10 @@
custom: ["https://buymeacoffee.com/aetherinox"]
github: # [repo-name, aetherinox]
patreon: # Replace with a single Patreon username
open_collective: # name
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username

109
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@@ -0,0 +1,109 @@
name: "🐛 Bug Report"
description: Found something you weren't expecting? Report it here!
title: "🐛 Bug: <title>"
labels: [
"Type ◦ Bug"
]
body:
- type: markdown
attributes:
value: |
1. Please speak `English`.
2. Make sure you are using the latest version and take a moment to check that your issue hasn't been reported before.
3. It's really important to provide pertinent details and logs,
incomplete details will be handled as an invalid report.
<br />
- type: textarea
id: description
attributes:
label: Description
description: |
Please provide a description of your issue here.
validations:
required: true
- type: textarea
id: steps-reproduce
attributes:
label: Steps To Reproduce
description: |
Describe the steps that need taken by the developer to get the error / issue you're experiencing.
value: |
-
-
-
-
validations:
required: true
- type: input
id: version-thetvapp
attributes:
label: "Version - Tag"
description: |
Version / tag you are pulling for `thetvapp`
placeholder: "Ex: 1.0.0"
validations:
required: true
- type: input
id: version-docker
attributes:
label: "Version - Docker"
description: "Version of docker you are running. Use command `docker --version`."
placeholder: "Ex: 27.2.0, build 3ab4256"
validations:
required: true
- type: dropdown
id: image-source
attributes:
label: Docker Image Source
description: |
Select which docker image you are pulling from
options:
- "Github"
- "Dockerhub"
- "Custom Built"
validations:
required: true
- type: dropdown
id: priority-type
attributes:
label: Priority
description: |
How critical is the issue?
Do not abuse this. Issues that completely break the utility would be classified as critical
options:
- "Low"
- "Normal"
- "High"
- "Urgent"
validations:
required: true
- type: textarea
id: docker-compose
attributes:
label: docker-compose.yml
description: |
Copy / paste your `docker-compose.yml` file here
- type: textarea
id: logs
attributes:
label: Logs
description: |
Paste your docker logs here.
Paste logs from inside mounted volume `/config/log/*`
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: |
Please provide screenshots of any errors or the issue you're having.
Gifs are even better.

View File

@@ -0,0 +1,33 @@
name: "💡 Feature Request"
description: Got a suggestion? Submit your request here.
title: "💡 Feature: <title>"
labels: [
"Type ◦ Feature"
]
body:
- type: markdown
attributes:
value: |
1. Please speak English.
2. Please take a moment to check that your feature hasn't already been suggested.
3. Be detailed but to the point.
- type: textarea
id: description
attributes:
label: Feature Description
placeholder: |
I would like to request ...
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: |
If possible, provide screenshots.
Want a feature placed in a specific location? Mark it in a screenshot.
Want something modified? Try creating a mockup.
The more details about how it should look, the better.
Not required, but appreciated.

49
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,49 @@
<!--
Pull Request
Ensure you read all of the sections carefully. Failure to fill this form out will result in your pull request being closed.
This text will remain hidden when you submit your pull request.
For your pull request title, use the format:
[BUG]: Brief title of the bug being fixed
[FEATURE]: Brief title of the feature being added
Failure to follow the above title format will result in your PR being ignored.
-->
# Pull Request
<small>Checkmark which topic best describes your contribution:</small>
- [ ] Feature
- [ ] Bug
- [ ] Documentation / Wiki
---
<!---------------------------------------------------------------------->
<br />
<!---------------------------------------------------------------------->
### Description
<small>Explain here what your pull request includes and what you've done</small>
<!---------------------------------------------------------------------->
<br />
---
<br />
<!---------------------------------------------------------------------->
### Before You Submit
<small>Please ensure you check the following items to indicate that you've read this section and completed each task</small>
- [ ] My code follows the [Contribution Guidelines](https://github.com/Aetherinox/thetvapp-docker/blob/main/CONTRIBUTING.md)
- [ ] I give expressed consent for my work to be used in this repo
- [ ] I have tested my work and it functions as intended
- [ ] I have included documentation if the change requires such

95
.github/changelog-configuration.json vendored Normal file
View File

@@ -0,0 +1,95 @@
{
"categories": [
{
"title": "\n\n<br>\n\n#### 🪛 Continuous integration",
"labels": [ "kind/ci", "ci" ]
},
{
"title": "\n\n<br>\n\n#### 🚀 Features",
"labels": [ "kind/feature", "feature", "feat" ]
},
{
"title": "\n\n<br>\n\n#### 🐛 Bugfixes",
"labels": [ "kind/bug", "fix", "bug" ]
},
{
"title": "\n\n<br>\n\n#### 🔧 Changes",
"labels": [ "kind/chore", "change", "chore" ]
},
{
"title": "\n\n<br>\n\nn#### ✨ Optimizations",
"labels": [ "kind/perf", "optimization", "perf", "optimize" ]
},
{
"title": "\n\n<br>\n\n#### 🚨 Security ",
"labels": [ "kind/security", "security" ]
},
{
"title": "\n\n<br>\n\n#### 🧹 Housekeeping",
"labels": [ "kind/refactor", "refactor", "style" ]
},
{
"title": "\n\n<br>\n\n#### 🐒 Miscellaneous",
"labels": [ "kind/misc", "misc" ]
},
{
"title": "\n\n<br>\n\n#### ⛔ Deprecated",
"labels": [ "kind/deprecate", "deprecate" ]
},
{
"title": "\n\n<br>\n\n#### ⛔ Removed",
"labels": [ "kind/remove", "remove" ]
},
{
"title": "\n\n<br>\n\n#### 📦 Build & Dependencies",
"labels": [ "kind/build", "build", "dependency", "dep", "package" ]
},
{
"title": "\n\n<br>\n\n#### ✏️ Docs",
"labels": [ "kind/docs", "doc", "docs", "wiki" ]
},
{
"title": "\n\n<br>\n\n#### 🧪 Tests & Demo Vault",
"labels": [ "kind/test", "test", "tests", "vault" ]
}
],
"sort": "ASC",
"pr_template": "- ${{TITLE_ONLY}} : #{{MERGE_SHA}} @#{{AUTHOR}}",
"empty_template": "- No major changes to address in this release",
"custom_placeholders": [
{
"name": "TITLE_ONLY",
"source": "TITLE",
"transformer": {
"method": "regexr",
"pattern": "(\\w+(\\(.+\\))?: ?)?(.+)",
"target": "$2 $3"
}
}
],
"label_extractor": [
{
"pattern": "^(build|ci|change|chore|doc|docs|wiki|remove|deprecate|security|dependency|dep|package|feat|feature|fix|bug|perf|optimize|optimization|refactor|style|test|tests|vault):(.*)",
"target": "$1",
"on_property": "title"
},
{
"pattern": "^(build|ci|change|chore|doc|docs|wiki|remove|deprecate|security|dependency|dep|package|feat|feature|fix|bug|perf|optimize|optimization|refactor|style|test|tests|vault){1}(\\([\\w\\-\\.]+\\))?(!)?:(.*)",
"target": "$1",
"on_property": "title"
}
],
"duplicate_filter": {
"pattern": "github.*",
"on_property": "author",
"method": "match"
},
"max_tags_to_fetch": 200,
"max_pull_requests": 200,
"max_back_track_time_days": 365,
"exclude_merge_branches": [],
"tag_resolver": {
"method": "semver"
},
"base_branches": []
}

39
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,39 @@
# #
# MIT License
#
# Copyright (c) 2025 Aetherinox
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# #
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: daily
labels:
- "Type ◦ Dependency"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
labels:
- "Type ◦ Git Action"

45
.github/labeler.yml vendored Normal file
View File

@@ -0,0 +1,45 @@
# Number of labels to fetch (optional). Defaults to 100
numLabels: 40
# These labels will not be used even if the issue contains them (optional).
# Pass a blank array if no labels are to be excluded.
# excludeLabels: []
excludeLabels:
- pinned
# custom configuration to override default behaviour
# control explicitly what gets added and when
custom:
- location: title
keywords:
- '[roadmap]'
labels:
- Type ◦ Roadmap
- location: title
keywords:
- '[road-map]'
labels:
- Type ◦ Roadmap
- location: title
keywords:
- '[bug]'
labels:
- Type ◦ Bug
- location: title
keywords:
- '[issue]'
labels:
- Type ◦ Bug
- location: title
keywords:
- '[feature]'
labels:
- Type ◦ Feature
- location: body
keywords:
- 'request feature'
labels:
- Type ◦ Feature
- location: title
keywords:
- '[request]'
labels:
- Type ◦ Feature