Skip to content

Add support for warning comments on a PR #144

Description

@espenjutte

As far as i can see right now we support mostly two modes: pass/fail, and the failure is displayed as an error in the terminal from the docker image that runs techdocs (in github actions).

When introducing new rules it would be nice to be able to output warnings instead of errors, so we could say "you wrote this like X, but it should probably be like Y" instead of it just being a pass/fail. Problem is of course nobody checks the GitHub actions for warnings, so we would need techdocs to make a comment in the PR on github for or like CodeQL add a comment that must be resolved. This is probably not trivial, but i think it could help a lot in getting acceptance for for example more advanced Vale rules and make the system a lot more flexible.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions