Skip to content

ci: enable conventional commit linting and add changelog commits#6

Merged
zeitlinger merged 11 commits intomainfrom
single-link-lint
Feb 16, 2026
Merged

ci: enable conventional commit linting and add changelog commits#6
zeitlinger merged 11 commits intomainfrom
single-link-lint

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Summary

  • Enable commitlint via Super-Linter to enforce conventional commit format (required by Release Please)
  • Add .commitlintrc.yml with @commitlint/config-conventional
  • Add conventional commit messages for all changes since v0.1.0 so Release Please can generate a changelog
  • Document conventional commit requirement in CLAUDE.md

Test plan

  • Verified commitlint rejects non-conventional commits (mise run lint fails)
  • Verified full lint suite passes with all conventional commits

Copilot AI review requested due to automatic review settings February 16, 2026 09:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request enables conventional commit linting via commitlint in Super-Linter and consolidates the link checking tasks into a single, more flexible script. The changes support Release Please for automated changelog generation while improving the developer experience through task consolidation and flag-based autofix control.

Changes:

  • Enable commitlint validation by removing VALIDATE_GIT_COMMITLINT=false from Super-Linter config and adding .commitlintrc.yml with conventional commit rules
  • Consolidate three separate link checking tasks (links, local-links, links-in-modified-files) into a single links.sh script with --full flag for comprehensive checking
  • Add --autofix flag support to super-linter.sh and renovate-deps.py, while maintaining backward compatibility with the AUTOFIX environment variable for propagation through the task dependency chain

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
.commitlintrc.yml New commitlint configuration extending @commitlint/config-conventional
.github/config/super-linter.env Enable commitlint by removing the disable flag
.markdownlint.json Disable MD041 rule to allow HTML/images before top-level heading
tasks/lint/super-linter.sh Add --autofix flag that sets AUTOFIX=true for FIX_* env var filtering
tasks/lint/renovate-deps.py Add --autofix flag support alongside existing AUTOFIX env var
tasks/lint/links.sh Consolidate link checking into single script with --full flag and smart defaults
tasks/lint/links-in-modified-files.sh Deleted (functionality merged into links.sh)
tasks/lint/local-links.sh Deleted (functionality merged into links.sh)
mise.toml Remove obsolete link checking task references and update descriptions
README.md Update documentation to reflect consolidated tasks and flag-based autofix
CLAUDE.md Document conventional commit requirement and updated task behavior
.github/workflows/lint.yml Update comment to reference consolidated lint:links task

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tasks/lint/renovate-deps.py Outdated
Comment thread tasks/lint/renovate-deps.py Outdated
def main():
"""Verify renovate-tracked-deps.json is up to date."""
autofix = os.environ.get("AUTOFIX", "").lower() == "true"
autofix = os.environ.get("AUTOFIX", "").lower() == "true" or os.environ.get("usage_autofix") == "true" # pylint: disable=line-too-long # noqa: E501
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The print statements at lines 118 and 150 still reference "AUTOFIX=true" but should be updated to match the new flag-based approach. Consider changing these messages to reference the --autofix flag for consistency with the updated documentation and user interface.

Copilot uses AI. Check for mistakes.
Comment thread README.md Outdated
Add commitlint config and enable VALIDATE_GIT_COMMITLINT so commits
to main are enforced to follow conventional commit format, which
Release Please requires to parse changelogs.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
- Use .lower() for usage_autofix env var check for consistency
- Update print messages to reference --autofix flag instead of AUTOFIX=true
- Update README to mention --autofix flag alongside AUTOFIX=true env var
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger merged commit e06aebd into main Feb 16, 2026
7 checks passed
@zeitlinger zeitlinger deleted the single-link-lint branch February 16, 2026 10:33
This was referenced Apr 16, 2026
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

Successfully merging this pull request may close these issues.

2 participants