Skip to content

feat: add validation results to comments#191

Open
wjhsf wants to merge 3 commits into
forcedotcom:mainfrom
wjhsf:wjh/hide-work-item-url-validation
Open

feat: add validation results to comments#191
wjhsf wants to merge 3 commits into
forcedotcom:mainfrom
wjhsf:wjh/hide-work-item-url-validation

Conversation

@wjhsf
Copy link
Copy Markdown

@wjhsf wjhsf commented Apr 8, 2026

Ever since #190 was merged, we've been seeing comments like salesforce/lwc#5774 (comment).

Git2Gus App is installed but the .git2gus/config.json doesn't have right values. You should add the required configuration.

There is no indication, in that message, of what is incorrect or how to fix it. We had followed the docs, and hadn't touched our config in a while, so we were confused as to what could be the issue. Upon investigation, the issue was that we had set hideWorkItemUrl to a boolean, true, when the expected value was a string, "true".

hideWorkItemUrl Some repositories are private or open source, when your repository is open source exposing internal urls is a security vulnerability. You will need to set this option to `true` in order to hide the url and use the WI-# instead. By default: `false`.

The documentation does not make it clear that the expected value is a string, rather than a boolean, for a boolean flag.

To address this issue, this PR makes two changes.

  1. hideWorkItemUrl now accepts boolean values, in addition to the strings "true" and "false".
  2. The PR comment also includes the validation results, to make it more clear what to fix.
  3. One test file resulted in logs printing after the jest test summary, which was inconvenient, so I suppressed the logging behavior in that file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant