usage: releasedocmaker [-h] [--dirversions] [--empty] [--extension EXTENSION]
                       [--fileversions] [-i] [-l] [-p PROJECT] [--prettyindex]
                       [-r] [--sortorder TYPE] [--sorttype TYPE] [-t TITLE]
                       [-u] [-v VERSION] [-V] [-O OUTPUT_DIRECTORY]
                       [-B BASE_URL] [--retries RETRIES] [--skip-credits]
                       [-X INCOMPATIBLE_LABEL] [-n LINT]

options:
  -h, --help            show this help message and exit
  --dirversions         Put files in versioned directories
  --empty               Create empty files when no issues
  --extension EXTENSION
                        Set the file extension of created Markdown files
  --fileversions        Write files with embedded versions
  -i, --index           build an index file
  -l, --license         Add an ASF license
  -p PROJECT, --project PROJECT
                        projects in JIRA to include in releasenotes
  --prettyindex         build an index file with pretty URLs
  -r, --range           Given versions are a range
  --sortorder TYPE      Sorting order for sort type (default: older)
  --sorttype TYPE       Sorting type for issues (default: resolutiondate)
  -t TITLE, --projecttitle TITLE
                        Title to use for the project (default is Apache
                        PROJECT)
  -u, --usetoday        use current date for unreleased versions
  -v VERSION, --version VERSION
                        versions in JIRA to include in releasenotes
  -V                    display version information for releasedocmaker and
                        exit.
  -O OUTPUT_DIRECTORY, --outputdir OUTPUT_DIRECTORY
                        specify output directory to put release docs to.
  -B BASE_URL, --baseurl BASE_URL
                        specify base URL of the JIRA instance.
  --retries RETRIES     Specify how many times to retry connection for each
                        URL.
  --skip-credits        While creating release notes skip the 'reporter' and
                        'contributor' columns
  -X INCOMPATIBLE_LABEL, --incompatiblelabel INCOMPATIBLE_LABEL
                        Specify the label to indicate backward
                        incompatibility.
  -n LINT, --lint LINT  Specify lint filters. Valid filters are
                        'incompatible', 'important', 'version', 'component',
                        'assignee'. 'all' enables all lint filters. Multiple
                        filters can be specified comma-delimited and filters
                        can be negated, e.g. 'all,-component'.

--project and --version may be given multiple times.

releasedocmaker --project YETUS --version 0.15.1 \
  --outputdir /tmp/rdm-yetus \
  --projecttitle 'Apache Yetus' --index

releasedocmaker --project YETUS --version 0.14.1 --version 0.15.1 \
  --outputdir /tmp/rdm-multi \
  --projecttitle 'Apache Yetus' \
  --index --prettyindex --fileversions

CHANGELOG.0.14.1.md
CHANGELOG.0.15.1.md
RELEASENOTES.0.14.1.md
RELEASENOTES.0.15.1.md
README.md
index.md

* Apache Yetus vRELEASENOTES.0.15.1.md
    * [Changelog](RELEASENOTES.0.15.1.md/CHANGELOG.RELEASENOTES.0.15.1.md)
    * [Release Notes](RELEASENOTES.0.15.1.md/RELEASENOTES.RELEASENOTES.0.15.1.md)
* Apache Yetus vRELEASENOTES.0.14.1.md
    * [Changelog](RELEASENOTES.0.14.1.md/CHANGELOG.RELEASENOTES.0.14.1.md)
    * [Release Notes](RELEASENOTES.0.14.1.md/RELEASENOTES.RELEASENOTES.0.14.1.md)

releasedocmaker --project MYPROJ --version 1.0.0 \
  --baseurl https://jira.example.com \
  --outputdir ./output --projecttitle 'My Project'

test-patch [OPTIONS] patch

Where:
  patch is a file, URL, or bugsystem-compatible location of the patch file

Options:

--archive-list=<list>             Comma delimited list of pattern matching
                                  notations to copy to patch-dir
--basedir=<dir>                   The directory to apply the patch to
                                  (default: current directory)
--branch-default=<ref>            If the branch isn't forced and we don't
                                  detect one in the patch name, use this
                                  branch (default 'main')
--branch=<ref>                    Forcibly set the branch
--bugcomments=<bug>               Only write comments to the screen and this
                                  comma delimited list (default: 'None: no
                                  plugins enabled')
--build-native=<bool>             If true, then build native components
                                  (default 'true')
--build-tool=<tool>               Pick which build tool to focus around
                                  (default: autodetect from 'nobuild')
--continuous-improvement=<bool>   If true, then do not exit with failure on
                                  branches (default: false)
--contrib-guide=<url>             URL to point new users towards project
                                  conventions. (default:
                                  https://yetus.apache.org/documentation/in-pr
                                  ogress/precommit-patchnames )
--debug                           If set, then output some extra stuff to
                                  stderr
--dirty-workspace                 Allow the local git workspace to have
                                  uncommitted changes
--empty-patch                     Create a summary of the current source tree
--excludes=<file>                 File of regexs to keep project files out of
                                  the set of changes passed to plugins.
--git-offline                     Do not fail if git cannot do certain remote
                                  operations
--git-shallow                     Repo does not know about other branches or
                                  tags
--ignore-unknown-options=<bool>   Continue despite unknown options (default:
                                  false)
--java-home=<path>                Set JAVA_HOME
--linecomments=<bug>              Only write line comments to this comma
                                  delimited list (default: same as
                                  --bugcomments)
--list-plugins                    List all installed plug-ins and then exit
--modulelist=<list>               Specify additional modules to test (comma
                                  delimited)
--multijdkdirs=<paths>            Comma delimited lists of JDK paths to use
                                  for multi-JDK tests
--multijdktests=<list>            Comma delimited tests to use when
                                  multijdkdirs is used. (default:
                                  'compile,unit,javadoc')
--offline                         Avoid connecting to the network
--patch-dir=<dir>                 The directory for working and output files
                                  (default '/tmp/test-patch-unknown/pid')
--personality=<file>              The personality file to load
--plugins=<list>                  Specify which plug-ins to add/delete (comma
                                  delimited; use 'all' for all found) e.g.
                                  --plugins=all,-ant,-scalac (all plugins
                                  except ant and scalac)
--proclimit=<num>                 Limit on the number of processes (default:
                                  2000)
--project=<name>                  The short name for project currently using
                                  test-patch (default 'yetus')
--report-unknown-options=<bool>   Print a warning in the report if
                                  --ignore-unknown-options=true and unknown
                                  options were found (default: true)
--resetrepo                       Forcibly clean the repo
--run-tests                       Run all relevant tests below the base
                                  directory
--skip-dirs=<list>                Skip following directories for module
                                  finding
--skip-system-plugins             Do not load plugins from
                                  /opt/yetus/lib/precommit/plugins.d
--summarize=<bool>                Allow tests to summarize results
--test-parallel=<bool>            Run multiple tests in parallel (default
                                  false in developer mode, true in Jenkins
                                  mode)
--test-threads=<int>              Number of tests to run in parallel (default
                                  defined in unknown build)
--tests-filter=<list>             Lists of tests to turn failures into
                                  warnings
--unit-test-filter-file=<file>    The unit test filter file to load
--user-plugins=<dir>              A directory of user provided plugins.
                                  (default: )
--version                         Print release version information and exit

Shell binary overrides:
--awk-cmd=<cmd>     The 'awk' command to use (default 'awk')
--curl-cmd=<cmd>    The 'curl' command to use (default 'curl')
--diff-cmd=<cmd>    The GNU-compatible 'diff' command to use (default 'diff')
--file-cmd=<cmd>    The 'file' command to use (default 'file')
--git-cmd=<cmd>     The 'git' command to use (default 'git')
--grep-cmd=<cmd>    The 'grep' command to use (default 'grep')
--patch-cmd=<cmd>   The 'patch' command to use (default 'patch')
--sed-cmd=<cmd>     The 'sed' command to use (default 'sed')

Automation options:
--build-url-artifacts=<location>   Location relative to --build-url of the
                                   --patch-dir (Default:
                                   'artifact/patchprocess')
--build-url-console=<location>     Location relative to --build-url of the
                                   console (Default: 'console')
--build-url=<url>                  Set the build location web page (Default:
                                   '')
--console-report-file=<file>       Save the final console-based report to a
                                   file in addition to the screen
--console-urls                     Use the build URL instead of path on the
                                   console report
--instance=<string>                Parallel execution identifier string
--mv-patch-dir                     Move the patch-dir into the basedir during
                                   cleanup
--robot                            Assume this is an automated run (default:
                                   auto-detect supported CI system)
--sentinel                         A very aggressive robot (auto: --robot)

Reminder: every plug-in may be enabled via 'all'.

BUILDTOOLS:
        nobuild ant autoconf cmake gradle make maven
TESTTYPES:
        ansiblelint asflicense author blanks buf buflint bufcompat cc checkmake checkstyle codespell detsecrets dupname golang golangcilint hadolint javac javadoc jshint jsonlint markdownlint mvnsite pathlen perlcritic pylint revive rubocop scalac scaladoc shellcheck shelldocs spotbugs test4tests unitveto xmllint yamllint
BUGSYSTEMS:
        briefreport bugzilla csvout github gitlab htmlout jira junit slack
TESTFORMATS:
        ctest junit tap

test-patch --project=demo \
  --basedir=/opt/demo-shell \
  --patch-dir=/tmp/tp-out \
  --plugins=shellcheck,shelldocs,blanks,test4tests \
  --build-tool=nobuild \
  --offline \
  /tmp/demo.patch

-1 overall
|  +1  |        blanks  |   0m  0s   | The patch has no blanks issues.
|  -1  |    shellcheck  |   0m  1s   | The patch generated 1 new + 0 unchanged
|      |                |            | - 0 fixed = 1 total (was 0)
|  +1  |     shelldocs  |   0m  0s   | No new issues.
|  shellcheck  | /tmp/tp-out/results-shellcheck.txt |
| Optional Tests | shellcheck shelldocs |
| Build tool | nobuild |
| versions | git=2.34.1 shellcheck=0.8.0 |
| Powered by | Apache Yetus 0.15.1 https://yetus.apache.org |

#!/usr/bin/env bash
# Demo personality: only enable shell checkers
personality_plugins "shellcheck,shelldocs,blanks"

function personality_parse_args
{
  echo "demo personality: no extra args"
}

function personality_globals
{
  YetusYetusPersonalityFlag=1
}

| Personality | /opt/demo-shell/.yetus/personality.sh |

demo personality: no extra args