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

more documentation needed #8

Open
MarcusWolschon opened this issue Nov 25, 2020 · 6 comments
Open

more documentation needed #8

MarcusWolschon opened this issue Nov 25, 2020 · 6 comments

Comments

@MarcusWolschon
Copy link

"This Action generates annotations from Android Lint Report XML."
does not adequately convey what this action does.

What is annotated and where are these annotations stored?

@yutailang0119
Copy link
Owner

Thanks!

"Annotations" will appear in the execution results on GitHub Actions.
For example, https://github.com/yutailang0119/action-android-lint/actions/runs/339294897 .

This repository is an action to display the execution result of Android Lint as an "annotation" in GitHub Actions.

@MarcusWolschon
Copy link
Author

The issue was not to have it answered here but in the README.md

@yutailang0119
Copy link
Owner

For those who understand GitHub Actions, it didn't seem like a problem.
If you have an idea, I welcome for your pull request!

@MarcusWolschon
Copy link
Author

That one sentence you gave would be enough. It just needs to end up in the readme.md

Github Actions is fairly new any most people don't yet understand all of it.
That they call "annotations" what everyone else calls "warnings" and "errors" is one such point.

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

No branches or pull requests

3 participants
@MarcusWolschon @yutailang0119 and others