Improvement: Refactor Gitlint Workflow to Support Dedicated Omit Word

[nradakovic]

Background

The current gitlint implementation in our GitHub workflows enforces checks such as the Issue-ref: validation in commit messages. While effective, it lacks flexibility for scenarios where commits do not need to reference an issue. To address this limitation, we propose introducing a dedicated omit word (e.g., NO-ISSUE) to bypass the Issue-ref: check.
Additionally, we aim to refactor this workflow into a standalone repository. This will enable us to publish the workflow on GitHub Marketplace, making it reusable and accessible to a broader audience.

Objectives

1. Introduce support for an omit word (e.g., NO-ISSUE) to skip the Issue-ref: validation in commit messages.
2. Refactor the Gitlint workflow into a dedicated repository for easy management and reusability.
3. Publish the refactored workflow on GitHub Marketplace with detailed documentation and usage instructions.

Acceptance Criteria

• A configurable keyword bypasses the Issue-ref: check when included in commit messages.
• The Gitlint workflow is refactored into a new standalone repository.The repository is well-structured and self-contained, with all required files and documentation.
• The workflow complies with GitHub Marketplace standards. Clear documentation and examples are provided for usage, customization, and setup.

Proposed Steps

• Design and Implementation:
  • Modify the Gitlint rules to accept a dedicated omit word as a bypass mechanism for the Issue-ref: check.
  • Make the omit word configurable via workflow inputs or a YAML configuration file.
• Refactor Workflow:
  • Extract the existing Gitlint workflow into a standalone repository.
  • Add supporting files such as a README.md, example workflows, and configuration templates.
• Testing and Validation:
  • Test the new omit word functionality across various commit message scenarios.
  • Validate the workflow in multiple repositories to ensure portability and reliability.
• Marketplace Publishing:
  • Prepare the workflow for GitHub Marketplace by following the required standards.
  • Submit the workflow with detailed documentation and metadata.

Resources

• Existing Gitlint implementation in the current workflows.
• Documentation on:
  • GitHub Actions;
  • Marketplace publishing requirements;

Impact

• Increased Flexibility: Developers will be able to bypass Issue-ref: checks when necessary, improving the user experience.
• Enhanced Reusability: A dedicated repository and Marketplace presence make the workflow easier to adopt across different projects and organizations.
• Improved Visibility: Publishing on GitHub Marketplace enhances discoverability and promotes best practices within the community.

NOTE: This ticket is subtask of: #36

[AlexanderLanin]

Let's wait for the discussion in #119.
So far there is a slight tendency to remove issue-ref completely.
This was also the intention while writing the new contribution guidelines.

[nradakovic]

Let's wait for the discussion in #119. So far there is a slight tendency to remove issue-ref completely. This was also the intention while writing the new contribution guidelines.

Understood. We can keep the ticket then in block state until #119 is not resolved.

[LittleHuba]

The title of the issue does not really reflect the acceptance criteria. @nradakovic would you mind adjusting the title to what the issue is about?

[AlexanderLanin]

@nradakovic I'll close this issue as it focuses on issue-ref. I know there is a valid part remaining regarding a gitlint workflow. Let's create a new issue for that in case we still want to do that? (reopen this issue in case I'm wrong!)