-
Notifications
You must be signed in to change notification settings - Fork 59
Add arguments to the /packit help command #3073
Copy link
Copy link
Open
Labels
area/generalNot tied to a specific areaNot tied to a specific areacomplexity/single-taskRegular task; should be done within daysRegular task; should be done within daysgain/lowDoesn't bring much value to usersDoesn't bring much value to usersgood-first-issueGood for newcomersGood for newcomersimpact/lowAffects only few of the usersAffects only few of the userskind/featureA request, idea, or new functionalityA request, idea, or new functionality
Description
Metadata
Metadata
Assignees
Labels
area/generalNot tied to a specific areaNot tied to a specific areacomplexity/single-taskRegular task; should be done within daysRegular task; should be done within daysgain/lowDoesn't bring much value to usersDoesn't bring much value to usersgood-first-issueGood for newcomersGood for newcomersimpact/lowAffects only few of the usersAffects only few of the userskind/featureA request, idea, or new functionalityA request, idea, or new functionality
As of now, Packit responds to the
/packit helpcommand in the comments of issues and PRs. It generates a response message containing the usage and a list of supported arguments.However, it shows only top-level arguments available, so the user wouldn't be informed about sub-arguments such as the
--commitsub-argument, which can be used following thecopr-buildargument like/packit copr-build --commit 123456.The help command should support listing sub-argument. For example, the command to retrieving the sub-arguments of the
copr-buildjob would be:/packit help buildThe implementation should be simple. The
GitCommentHelpHandlerwould need to be editted. Theformat_helpmethod can still be used, but it has to be called on the relevant parser object (the relevant sub-parser of the top-level parser). For example, the "copr-build" subparser would need to be retrieved in the case of sub-arguments relevant to/packit copr-build.In case an argument doesn't support any sub-argument (for example
rebuild-failed), Packit should still respond to/packit help rebuild-failed, but should make it clear to the user that there are no sub-arguments available.