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 GitHub code annotations on typechecking error #1

Open
aabounegm opened this issue Sep 28, 2023 · 0 comments
Open

Add GitHub code annotations on typechecking error #1

aabounegm opened this issue Sep 28, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@aabounegm
Copy link
Member

aabounegm commented Sep 28, 2023

Annotations in GitHub Actions look like so:
image

It would be useful if this action can provide annotations to help spot the error directly in the code review page of a pull request. This can be done with the annotations-action, which requires input in the following format:

[
  {
    "file": "path/to/file.rzk.md",
    "line": 5,
    "title": "Title of the error message",
    "message": "Details about the error message",
    "annotation_level": "failure"
  }
]

This probably requires Rzk itself to support JSON output format.
More details about annotations can also be found in this blog post

@aabounegm aabounegm added the enhancement New feature or request label Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant