What are annotations? #25002
-
In the email reports when my Workflow fails, I see mentions of annotations, like “$xyz succeeded (0 annotations)”. What are annotations? The search bar on help.github.com doesn’t show any relevant results. |
Beta Was this translation helpful? Give feedback.
Replies: 9 comments
-
Ahh, that email is confusing. https://help.github.com/en/articles/about-status-checks See the comments on the lines of code? That’s an annotation. We have an API that allows annotations to be created during a CI run. They aren’t supported in Actions yet, but will be. |
Beta Was this translation helpful? Give feedback.
-
@mscoutermarsh any idea when annotations will be supported again? I have a couple actions that need to be migrated to v2 that do this but I’m unable to create annotations with v2 actions. I can run v1 action in a v2 workflow and annotations will be created just fine, but a v2 style action doesn’t. I can create the checks run, but when I try to update it with the annotations I get a 422 response. |
Beta Was this translation helpful? Give feedback.
-
I have had some success (kind of) for adding annotations:
With this method I can add annotations: The real downside is, that annotation can only be viewed in files changed with the commit: … So because I wanted to add the test results directly to the failing test, I am out of luck when a test fails which has not been changed with the current commit. Hopefully the code samples are helpful for you. |
Beta Was this translation helpful? Give feedback.
-
How can I add annotations to my npm test workflow which I have created? My response after running the test:
|
Beta Was this translation helpful? Give feedback.
-
I see when my check run is running the status is from ‘queued’ to ‘completed’. I dont see ‘in_progress’. Any thoughts what I am missing ? |
Beta Was this translation helpful? Give feedback.
-
Any update on this, or when the feature might be available? |
Beta Was this translation helpful? Give feedback.
-
Current way annotations where implemented seems quite weird for me as I was expecting to be able to create annotation reports on disk which would be loaded by github after the build finished, avoiding the need to perform API calls during build. Current implementation just creates a vendor-lockin by requesting each tool that can produce annotation like output to add specific support for GitHub. I asked recently on https://stackoverflow.com/questions/62516223/how-can-i-produce-github-annotations-by-creating-report-files-on-disk as I suppose I am not the first one that asks himself about lack of portability. Do we have any file format that we can use for annotations and rely on a generic reported to send them to github? |
Beta Was this translation helpful? Give feedback.
-
Are there any updates on this? I’d like to make some annotations from an action. |
Beta Was this translation helpful? Give feedback.
-
Any idea on how can we create links to the annotations. I want to add link to the annotations which is created using check run update API in comments but not able to figure out how can I get annotation id. |
Beta Was this translation helpful? Give feedback.
Ahh, that email is confusing.
https://help.github.com/en/articles/about-status-checks
See the comments on the lines of code? That’s an annotation. We have an API that allows annotations to be created during a CI run.
They aren’t supported in Actions yet, but will be.