Skip to content

Commit f1d2f8b

Browse files
committed
chore: update .github files
1 parent 83717f0 commit f1d2f8b

7 files changed

+380
-0
lines changed

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug-report.yml

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: "🐛 Bug Report"
2+
description: Found something you weren't expecting? Report it here!
3+
title: "🐛 Bug: <title>"
4+
labels: [
5+
"Type ◦ Bug"
6+
]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
1. Please speak `English`.
12+
2. Make sure you are using the latest version and take a moment to check that your issue hasn't been reported before.
13+
3. It's really important to provide pertinent details and logs,
14+
incomplete details will be handled as an invalid report.
15+
16+
<br />
17+
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: Description
22+
description: |
23+
Please provide a description of your issue here.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: steps-reproduce
29+
attributes:
30+
label: Steps To Reproduce
31+
description: |
32+
Describe the steps that need taken by the developer to get the error / issue you're experiencing.
33+
value: |
34+
-
35+
-
36+
-
37+
-
38+
validations:
39+
required: true
40+
41+
- type: input
42+
id: version-thetvapp
43+
attributes:
44+
label: "Version - Tag"
45+
description: |
46+
Version / tag you are pulling for `thetvapp`
47+
placeholder: "Ex: 1.0.0"
48+
validations:
49+
required: true
50+
51+
- type: input
52+
id: version-docker
53+
attributes:
54+
label: "Version - Docker"
55+
description: "Version of docker you are running. Use command `docker --version`."
56+
placeholder: "Ex: 27.2.0, build 3ab4256"
57+
validations:
58+
required: true
59+
60+
- type: dropdown
61+
id: image-source
62+
attributes:
63+
label: Docker Image Source
64+
description: |
65+
Select which docker image you are pulling from
66+
options:
67+
- "Github"
68+
- "Dockerhub"
69+
- "Custom Built"
70+
validations:
71+
required: true
72+
73+
- type: dropdown
74+
id: priority-type
75+
attributes:
76+
label: Priority
77+
description: |
78+
How critical is the issue?
79+
Do not abuse this. Issues that completely break the utility would be classified as critical
80+
options:
81+
- "Low"
82+
- "Normal"
83+
- "High"
84+
- "Urgent"
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: docker-compose
90+
attributes:
91+
label: docker-compose.yml
92+
description: |
93+
Copy / paste your `docker-compose.yml` file here
94+
95+
- type: textarea
96+
id: logs
97+
attributes:
98+
label: Logs
99+
description: |
100+
Paste your docker logs here.
101+
Paste logs from inside mounted volume `/config/log/*`
102+
103+
- type: textarea
104+
id: screenshots
105+
attributes:
106+
label: Screenshots
107+
description: |
108+
Please provide screenshots of any errors or the issue you're having.
109+
Gifs are even better.
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "💡 Feature Request"
2+
description: Got a suggestion? Submit your request here.
3+
title: "💡 Feature: <title>"
4+
labels: [
5+
"Type ◦ Feature"
6+
]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
1. Please speak English.
12+
2. Please take a moment to check that your feature hasn't already been suggested.
13+
3. Be detailed but to the point.
14+
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Feature Description
19+
placeholder: |
20+
I would like to request ...
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: screenshots
26+
attributes:
27+
label: Screenshots
28+
description: |
29+
If possible, provide screenshots.
30+
Want a feature placed in a specific location? Mark it in a screenshot.
31+
Want something modified? Try creating a mockup.
32+
The more details about how it should look, the better.
33+
Not required, but appreciated.

.github/PULL_REQUEST_TEMPLATE.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
3+
Pull Request
4+
5+
Ensure you read all of the sections carefully. Failure to fill this form out will result in your pull request being closed.
6+
7+
This text will remain hidden when you submit your pull request.
8+
9+
For your pull request title, use the format:
10+
[BUG]: Brief title of the bug being fixed
11+
[FEATURE]: Brief title of the feature being added
12+
13+
Failure to follow the above title format will result in your PR being ignored.
14+
15+
-->
16+
17+
# Pull Request
18+
<small>Checkmark which topic best describes your contribution:</small>
19+
20+
- [ ] Feature
21+
- [ ] Bug
22+
- [ ] Documentation / Wiki
23+
24+
---
25+
26+
<!---------------------------------------------------------------------->
27+
<br />
28+
<!---------------------------------------------------------------------->
29+
30+
31+
### Description
32+
<small>Explain here what your pull request includes and what you've done</small>
33+
34+
35+
<!---------------------------------------------------------------------->
36+
<br />
37+
38+
---
39+
40+
<br />
41+
<!---------------------------------------------------------------------->
42+
43+
### Before You Submit
44+
<small>Please ensure you check the following items to indicate that you've read this section and completed each task</small>
45+
46+
- [ ] My code follows the [Contribution Guidelines](https://github.com/Aetherinox/thetvapp-docker/blob/main/CONTRIBUTING.md)
47+
- [ ] I give expressed consent for my work to be used in this repo
48+
- [ ] I have tested my work and it functions as intended
49+
- [ ] I have included documentation if the change requires such

.github/changelog-configuration.json

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"categories": [
3+
{
4+
"title": "\n\n<br>\n\n#### 🪛 Continuous integration",
5+
"labels": [ "kind/ci", "ci" ]
6+
},
7+
{
8+
"title": "\n\n<br>\n\n#### 🚀 Features",
9+
"labels": [ "kind/feature", "feature", "feat" ]
10+
},
11+
{
12+
"title": "\n\n<br>\n\n#### 🐛 Bugfixes",
13+
"labels": [ "kind/bug", "fix", "bug" ]
14+
},
15+
{
16+
"title": "\n\n<br>\n\n#### 🔧 Changes",
17+
"labels": [ "kind/chore", "change", "chore" ]
18+
},
19+
{
20+
"title": "\n\n<br>\n\nn#### ✨ Optimizations",
21+
"labels": [ "kind/perf", "optimization", "perf", "optimize" ]
22+
},
23+
{
24+
"title": "\n\n<br>\n\n#### 🚨 Security ",
25+
"labels": [ "kind/security", "security" ]
26+
},
27+
{
28+
"title": "\n\n<br>\n\n#### 🧹 Housekeeping",
29+
"labels": [ "kind/refactor", "refactor", "style" ]
30+
},
31+
{
32+
"title": "\n\n<br>\n\n#### 🐒 Miscellaneous",
33+
"labels": [ "kind/misc", "misc" ]
34+
},
35+
{
36+
"title": "\n\n<br>\n\n#### ⛔ Deprecated",
37+
"labels": [ "kind/deprecate", "deprecate" ]
38+
},
39+
{
40+
"title": "\n\n<br>\n\n#### ⛔ Removed",
41+
"labels": [ "kind/remove", "remove" ]
42+
},
43+
{
44+
"title": "\n\n<br>\n\n#### 📦 Build & Dependencies",
45+
"labels": [ "kind/build", "build", "dependency", "dep", "package" ]
46+
},
47+
{
48+
"title": "\n\n<br>\n\n#### ✏️ Docs",
49+
"labels": [ "kind/docs", "doc", "docs", "wiki" ]
50+
},
51+
{
52+
"title": "\n\n<br>\n\n#### 🧪 Tests & Demo Vault",
53+
"labels": [ "kind/test", "test", "tests", "vault" ]
54+
}
55+
],
56+
"sort": "ASC",
57+
"pr_template": "- ${{TITLE_ONLY}} : #{{MERGE_SHA}} @#{{AUTHOR}}",
58+
"empty_template": "- No major changes to address in this release",
59+
"custom_placeholders": [
60+
{
61+
"name": "TITLE_ONLY",
62+
"source": "TITLE",
63+
"transformer": {
64+
"method": "regexr",
65+
"pattern": "(\\w+(\\(.+\\))?: ?)?(.+)",
66+
"target": "$2 $3"
67+
}
68+
}
69+
],
70+
"label_extractor": [
71+
{
72+
"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):(.*)",
73+
"target": "$1",
74+
"on_property": "title"
75+
},
76+
{
77+
"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\\-\\.]+\\))?(!)?:(.*)",
78+
"target": "$1",
79+
"on_property": "title"
80+
}
81+
],
82+
"duplicate_filter": {
83+
"pattern": "github.*",
84+
"on_property": "author",
85+
"method": "match"
86+
},
87+
"max_tags_to_fetch": 200,
88+
"max_pull_requests": 200,
89+
"max_back_track_time_days": 365,
90+
"exclude_merge_branches": [],
91+
"tag_resolver": {
92+
"method": "semver"
93+
},
94+
"base_branches": []
95+
}

.github/dependabot.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# #
2+
# MIT License
3+
#
4+
# Copyright (c) 2025 Aetherinox
5+
#
6+
# Permission is hereby granted, free of charge, to any person obtaining a copy
7+
# of this software and associated documentation files (the "Software"), to deal
8+
# in the Software without restriction, including without limitation the rights
9+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
# copies of the Software, and to permit persons to whom the Software is
11+
# furnished to do so, subject to the following conditions:
12+
#
13+
# The above copyright notice and this permission notice shall be included in all
14+
# copies or substantial portions of the Software.
15+
#
16+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
# SOFTWARE.
23+
# #
24+
25+
version: 2
26+
updates:
27+
- package-ecosystem: npm
28+
directory: "/"
29+
schedule:
30+
interval: daily
31+
labels:
32+
- "Type ◦ Dependency"
33+
34+
- package-ecosystem: "github-actions"
35+
directory: "/"
36+
schedule:
37+
interval: "daily"
38+
labels:
39+
- "Type ◦ Git Action"

.github/labeler.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Number of labels to fetch (optional). Defaults to 100
2+
numLabels: 40
3+
# These labels will not be used even if the issue contains them (optional).
4+
# Pass a blank array if no labels are to be excluded.
5+
# excludeLabels: []
6+
excludeLabels:
7+
- pinned
8+
# custom configuration to override default behaviour
9+
# control explicitly what gets added and when
10+
custom:
11+
- location: title
12+
keywords:
13+
- '[roadmap]'
14+
labels:
15+
- Type ◦ Roadmap
16+
- location: title
17+
keywords:
18+
- '[road-map]'
19+
labels:
20+
- Type ◦ Roadmap
21+
- location: title
22+
keywords:
23+
- '[bug]'
24+
labels:
25+
- Type ◦ Bug
26+
- location: title
27+
keywords:
28+
- '[issue]'
29+
labels:
30+
- Type ◦ Bug
31+
- location: title
32+
keywords:
33+
- '[feature]'
34+
labels:
35+
- Type ◦ Feature
36+
- location: body
37+
keywords:
38+
- 'request feature'
39+
labels:
40+
- Type ◦ Feature
41+
- location: title
42+
keywords:
43+
- '[request]'
44+
labels:
45+
- Type ◦ Feature

0 commit comments

Comments
 (0)