Skip to content

Add clear error annotations for commitlint github actions #56

Closed
@aj3sh

Description

@aj3sh

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.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions