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

Add clear error annotations for commitlint github actions #56

Closed
aj3sh opened this issue Jul 16, 2024 · 0 comments · Fixed by #61
Closed

Add clear error annotations for commitlint github actions #56

aj3sh opened this issue Jul 16, 2024 · 0 comments · Fixed by #61
Assignees
Labels
enhancement New feature or request

Comments

@aj3sh
Copy link
Member

aj3sh commented Jul 16, 2024

Problem Statement

When commitlint fails on GitHub Actions, the summary/error messages of the commitlint are not clear. We have to visit the action logs to find out which commit doesn't follow the conventional commit message, which is difficult to read.
Image
Image

Proposed Solution

GitHub Annotations will help view the commitlint error status more clearly. Below is a sample example of GitHub Annotations displaying the commitlint status:
Image

Impacts

This might not create a breaking change. However, the implementation of the GitHub actions will be changed.

@aj3sh aj3sh added this to Commitlint Jun 26, 2024
@aj3sh aj3sh converted this from a draft issue Jul 16, 2024
@aj3sh aj3sh added the enhancement New feature or request label Jul 16, 2024
@aj3sh aj3sh self-assigned this Jul 20, 2024
@aj3sh aj3sh closed this as completed in #61 Aug 7, 2024
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
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant