API¶
CLI Arguments¶
Generate release notes from YAML files. Entries are sorted by order in yaml files, and by order of yaml files provided via the command line.
[38;5;208mUsage:[0m [38;5;244msphinx-build[0m [[36m-h[0m] [[36m-t[0m [38;5;36m[WRITE_YAML_TEMPLATE][0m] [[36m-c[0m [38;5;36m[GET_CHANGED_FILES][0m] [[36m-r[0m [38;5;36mVERSION[0m] [[36m-d[0m [38;5;36mRELEASE_DATE[0m] [[36m-nc[0m] [[36m-p[0m [38;5;36mPREFIX_FILE[0m] [[36m-s[0m [38;5;36mSUFFIX_FILE[0m] [[36m-o[0m [38;5;36mOUTPUT_FILE[0m] [[36m--output-to-console[0m] [[36m-nr[0m] [[36m-q[0m] [[36minput_files_or_folders[0m ...]
Positional Arguments¶
- input_files_or_folders
The folder(s) containing YAML files and/or YAML files. Folders will be searched recursively.
Named Arguments¶
- -t, --write-yaml-template
Write template YAML to provided file. If folder provided, place template in folder with current git branch name as file name.
- -c, --get-changed-files
Print git tracked file changes against main. If directory provided, use that directories checked-out branch.
- -r, --release-version
Version number of the release. Default is ‘[UNKNOWN]’.
Default: “[UNKNOWN]”
- -d, --release-date
Date of the release. Default is current system time.
- -nc, --no-color
Disable text formatting for CLI output.
Default: False
- -p, --prefix-file
A header file to prepend to the release notes.
- -s, --suffix-file
A footer file to suffix to the release notes.
- -o, --output-file
The output file for release notes.
- --output-to-console
Write generated release notes to console.
Default: False
- -nr, --no-rich
Disable rich text output
Default: False
- -q, --quiet
Only output errors
Default: False