summaryrefslogtreecommitdiffstats
path: root/devscripts/make_issue_template.py
diff options
context:
space:
mode:
Diffstat (limited to 'devscripts/make_issue_template.py')
-rw-r--r--devscripts/make_issue_template.py78
1 files changed, 78 insertions, 0 deletions
diff --git a/devscripts/make_issue_template.py b/devscripts/make_issue_template.py
new file mode 100644
index 0000000..39b95c8
--- /dev/null
+++ b/devscripts/make_issue_template.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+
+# Allow direct execution
+import os
+import sys
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+
+import re
+
+from devscripts.utils import (
+ get_filename_args,
+ read_file,
+ read_version,
+ write_file,
+)
+
+VERBOSE_TMPL = '''
+ - type: checkboxes
+ id: verbose
+ attributes:
+ label: Provide verbose output that clearly demonstrates the problem
+ options:
+ - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
+ required: true
+ - label: "If using API, add `'verbose': True` to `YoutubeDL` params instead"
+ required: false
+ - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below
+ required: true
+ - type: textarea
+ id: log
+ attributes:
+ label: Complete Verbose Output
+ description: |
+ It should start like this:
+ placeholder: |
+ [debug] Command-line config: ['-vU', 'test:youtube']
+ [debug] Portable config "yt-dlp.conf": ['-i']
+ [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8
+ [debug] yt-dlp version %(version)s [9d339c4] (win32_exe)
+ [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0
+ [debug] Checking exe version: ffmpeg -bsfs
+ [debug] Checking exe version: ffprobe -bsfs
+ [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1
+ [debug] Optional libraries: Cryptodome-3.15.0, brotli-1.0.9, certifi-2022.06.15, mutagen-1.45.1, sqlite3-2.6.0, websockets-10.3
+ [debug] Proxy map: {}
+ [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest
+ Latest version: %(version)s, Current version: %(version)s
+ yt-dlp is up to date (%(version)s)
+ <more lines>
+ render: shell
+ validations:
+ required: true
+'''.strip()
+
+NO_SKIP = '''
+ - type: checkboxes
+ attributes:
+ label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
+ description: Fill all fields even if you think it is irrelevant for the issue
+ options:
+ - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\\* field
+ required: true
+'''.strip()
+
+
+def main():
+ fields = {'version': read_version(), 'no_skip': NO_SKIP}
+ fields['verbose'] = VERBOSE_TMPL % fields
+ fields['verbose_optional'] = re.sub(r'(\n\s+validations:)?\n\s+required: true', '', fields['verbose'])
+
+ infile, outfile = get_filename_args(has_infile=True)
+ write_file(outfile, read_file(infile) % fields)
+
+
+if __name__ == '__main__':
+ main()