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

Use github actions annotations for warnings #10

Open
LucioFranco opened this issue Dec 20, 2019 · 2 comments
Open

Use github actions annotations for warnings #10

LucioFranco opened this issue Dec 20, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@LucioFranco
Copy link

This github action should take advantage of the annotations feature for making it easier for users to find the issues when the action fails. I think if the Cargo.toml is present in the diff then you can add the annotation there. If it is not it could just be appended to the end of the diff.

A good reference is the https://github.com/actions-rs/clippy-check action which uses this feature.

@Jake-Shadle
Copy link
Member

Unfortunately annotations are limited to files that actually exist in the repository the action is executed on, but there is the possibility to add a markdown file as the summary for the entire job that supports full github markdown, so adding output/graphs here seems to be the way forward.

Related: EmbarkStudios/cargo-deny#433

@adam-azarchs
Copy link

If your PR adds a new dependency which triggers an issue, the annotation could be on the line in your Cargo.toml which adds the dependency. This isn't super helpful for transitive dependencies, nor is it all that helpful for lockfile-only updates - you could put the annotations in Cargo.lock, if present, but GitHub suppresses the diffs there by default.

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

3 participants