Skip to content

Developer Friendly Actions Message #7

@abhisek

Description

@abhisek

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions