Add arg for changing pull request title

[mdanish-kh]

• Have you signed the Contributor License Agreement?
• Are you working against an Issue?
  • Add ability to pass in a PR title with submit and update #359

Description of the changes

• Add an optional parameter prTitle to BaseCommand.GitHubSubmitManifests and avoid breaking existing calls of this function.
• For PR Title validation, let GitHub Api handle the validation and show exception message to user. The downside is (I think) the messages won't be localized, but the upside being anytime the validation (let's say PR title max length) changes at the api side, we wouldn't have to update it manually in the code 👀
• In case title exceeds max length, it will be caught in ApiValidationException. The current limit seems to be 1024 characters (albeit the error response message says 256 chars)
  • image.png (error response)
  • image2.png (exception handled in winget-create)
• If no title is provided, the default message of <PackageId> version <PackageVersion> will be used.
• For empty strings with only whitespaces, the exception is caught in ArgumentException
  • image.png (error response)
  • image2.png (exception handled in winget-create)
• Updated E2E tests and docs for the new parameter

Need feedback

Since --prtitle for update command is only applicable when the --submit flag is used, then what if a user was to use --prtitle in the update command without setting the submit flag?

I looked at getting a native solution from CommandLineParser to handle this option dependency on another option, but couldn't find the capability in the module to do so. Related issue: commandlineparser/commandline#3

The alternative would be to handle it manually in the code and print a localized warning message something like "Submit flag is not set. The value of title is ignored.", but since this seems like a harmless scenario I decided not to handle it. Please let me know if I am thinking wrong about any of this.

---

Microsoft Reviewers: Open in CodeFlow

[ryfu-msft]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[ryfu-msft]

I think what you have is perfectly fine. Ideally, we would want to show a warning message to the user that --submit is needed in combination with --prtitle, but I think the user will ultimately figure that out when they realize that no PR was submitted. I agree with you that this is a pretty harmless/trivial scenario. Everything else looks good :)

[ryfu-msft]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[ryfu-msft]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mdanish-kh]

Oopsies, found an unwanted change I mistakenly made in Resources.Designer.cs. Fixed in the recent commit.

[ryfu-msft]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).