Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH1017 log result and full description don't seem to align #2822

Open
3flex opened this issue Sep 28, 2024 · 0 comments
Open

GH1017 log result and full description don't seem to align #2822

3flex opened this issue Sep 28, 2024 · 0 comments

Comments

@3flex
Copy link

3flex commented Sep 28, 2024

This log output for GH1017:

<data name="GH1017_ProvideRequiredPhysicalLocationProperties_Error_MissingArtifactLocationUri_Text" xml:space="preserve">
<value>{0}: The 'artifactLocation' object on this 'physicalLocation' object does not provide a 'uri' object. This property is required by the {1} service.</value>
</data>

And this full description for the same rule:

<data name="GH1017_ProvideRequiredPhysicalLocationProperties_FullDescription_Text" xml:space="preserve">
<value>Provide the 'region' property, along with the appropriate region properties. This property is required by the GitHub Advanced Security service.
Provide the 'artifactLocation' property. This property is required by the GitHub Advanced Security service.</value>
</data>

Are quite different. GH1017 logic seems to be checking that if artifactLocation is included in the SARIF report output then its uri property must be set. This makes sense as a rule. But the full description says artifactLocation should be included in the output, and region as well, but these aren't the checks that are actually being executed by this rule, so the output is quite confusing.

Possibly related to #2821 however artifactLocation.uri is being set there so that doesn't seem to be the root cause for that issue either.

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

No branches or pull requests

1 participant