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

Would be nice to know what violations are found. #30

Open
jagthedrummer opened this issue Oct 17, 2022 · 2 comments
Open

Would be nice to know what violations are found. #30

jagthedrummer opened this issue Oct 17, 2022 · 2 comments

Comments

@jagthedrummer
Copy link

Currently this action only says "you got something wrong" and it leaves it up to you to figure out what. It would nice if it would report what part of the spec it's complaining about.

Like if the PR title is disable a flaky test it would be nice if the action somewhere listed that it's in violation because it's missing the <type>: prefix instead of leaving it up to the user to guess about what's not right.

@thehanimo
Copy link
Owner

The way the check is structured, in general, is to see if the title matches at least one template out of the many specified (via regex and/or prefixes). A failing test indicates that the current title does not match any valid template. I don't see how we could give a suggestion here? I do like the idea but the only feedback I can think of is listing out all valid templates and then say that the current one does not match any of them.

@andrepaschoal
Copy link

Folks, I was wondering if a custom message in the output would do the job. e.g.

Not enough magical as it demands some glue work, but perhaps that's all that's needed 🤷‍♂️

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