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

Developer Friendly Actions Message #7

Open
abhisek opened this issue Dec 22, 2022 · 0 comments
Open

Developer Friendly Actions Message #7

abhisek opened this issue Dec 22, 2022 · 0 comments

Comments

@abhisek
Copy link
Member

abhisek commented Dec 22, 2022

Current State

sane fails when the repository structure do not match the .sane file. In case of failure or error, it prints messages that are not intuitive. Example

time="2022-11-30T10:49:27Z" level=info msg="Using Repository: ."
time="2022-11-30T10:49:27Z" level=info msg="Using Rule: ./.sane"
time="2022-11-30T10:49:2[7](https://github.com/boringtools/sane/actions/runs/3582518206/jobs/6026995383#step:4:8)Z" level=info msg="Strict mode: false"
time="2022-11-30T10:49:27Z" level=info msg="Fail fast mode: false"
time="2022-11-30T10:4[9](https://github.com/boringtools/sane/actions/runs/3582518206/jobs/6026995383#step:4:10):27Z" level=info msg="Using ref: HEAD"
time="2022-11-30T[10](https://github.com/boringtools/sane/actions/runs/3582518206/jobs/6026995383#step:4:11):49:27Z" level=info msg="Finished validation"

Proposed Improvements

Print an explicit success message when successful. In case of error, print an error message with link to documentation on how to resolve this issue. Even better would be to decorate the line in .sane file (in case of PR) that caused the failure

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

1 participant