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

Add initial Buildcheck codes #10250

Merged
merged 2 commits into from
Jun 24, 2024
Merged

Add initial Buildcheck codes #10250

merged 2 commits into from
Jun 24, 2024

Conversation

JanKrivanek
Copy link
Member

Contributes to #10240

Context

Customer requested to have understandable documentation of individual imposed rules.
Let's follow similar practice we introduced in template engine - with adding short hyperlinks to the outputs, that can then include rich information, that can freely evolve off-cycle.

Changes Made

Added initial document
Added initial code adding the hyperlink

What remains TBD for the bug (but out of scope of this PR)

  • Adding a document for custom codes (that will not have enumeration, but just an overview of what custom analyzer are, how they can appear in your build and how you can understand and troubleshoot the reports)
  • Conditionalize the link adding code - so that it uses different link for custom analyzers (this will be easy after [Built-in analyzer] Undefined property is used #9883 is done - as it'll introduce internal overload of the base class, that will be used by built-in analyzers)
  • Adding a link to finalized guidelines - once [BuildCheck]: Guide of rules/analyzers id name #10088 is finalized

UX

image

Copy link
Contributor

@maridematte maridematte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we wait to merge this after the guidelines are established? Or go for it now and update later.

@JanKrivanek
Copy link
Member Author

Should we wait to merge this after the guidelines are established? Or go for it now and update later.

I'd see it as almost independent.
This is just a basement that we'll build upon

documentation/specs/proposed/BuildCheck/Codes.md Outdated Show resolved Hide resolved
documentation/specs/proposed/BuildCheck/Codes.md Outdated Show resolved Hide resolved
documentation/specs/proposed/BuildCheck/Codes.md Outdated Show resolved Hide resolved
Copy link
Member

@rainersigwald rainersigwald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with Chet's edits

@rainersigwald rainersigwald enabled auto-merge (squash) June 24, 2024 21:50
@rainersigwald rainersigwald merged commit c7904f2 into main Jun 24, 2024
10 checks passed
@rainersigwald rainersigwald deleted the proto/buildcheck-codes branch June 24, 2024 22:31
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.

5 participants