Add a gitlint check in CI by mulkieran · Pull Request #4063 · stratis-storage/stratisd

mulkieran · 2026-08-04T18:47:08Z

Summary by CodeRabbit

Chores
- Added automated commit message checks to the pull request workflow.
- Configured commit validation to allow messages without a body.
- Excluded commit-check configuration from packaged files.

Signed-off-by: mulhern <amulhern@redhat.com>

packit-as-a-service · 2026-08-04T19:41:29Z

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

sudo dnf install -y 'dnf*-command(copr)'
dnf copr enable packit/stratis-storage-stratisd-4063-copr_pull
And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

mulkieran · 2026-08-04T20:26:43Z

It works!

mulkieran · 2026-08-05T01:06:37Z

@coderabbitai review

coderabbitai · 2026-08-05T01:06:44Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2026-08-05T01:16:23Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b1a42b92-de01-4535-9b12-3d8eda36f638

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31f67 and ac83d67.

📒 Files selected for processing (3)

.github/workflows/main.yml
.gitlint
Cargo.toml

🚧 Files skipped from review as they are similar to previous changes (3)

Cargo.toml
.gitlint
.github/workflows/main.yml

Walkthrough

Changes

Commit linting

Layer / File(s)	Summary
Configure Gitlint files `.gitlint`, `Cargo.toml`	Gitlint excludes the `body-is-missing` rule. Cargo excludes `/.gitlint` from the package file list.
Run commit linting `.github/workflows/main.yml`	GitHub Actions adds a `commit-checks` job. It installs Git and gitlint, checks out full history, marks the workspace safe, and validates commits from the pull request base branch to `HEAD`.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the primary change: adding a gitlint check to CI.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/main.yml:
- Around line 368-382: Update the gitlint step in the commit-checks job to
select an event-specific revision range: use github.event.before..github.sha for
push events and retain origin/${{ github.base_ref }}..HEAD for pull_request
events. Ensure the workflow never constructs an invalid origin/..HEAD range.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c0ab95b0-6df0-4d2d-9a04-b53d947ac6fc

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31f67 and 8d82ad1.

📒 Files selected for processing (3)

.github/workflows/main.yml
.gitlint
Cargo.toml

coderabbitai · 2026-08-05T01:16:26Z

+  commit-checks:
+    runs-on: ubuntu-24.04
+    container:
+      image: fedora:43  # CURRENT DEVELOPMENT ENVIRONMENT
+    steps:
+      - name: Install dependencies
+        run: dnf install -y git gitlint
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: allow gitlint to process commits
+        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - name: gitlint
+        run: gitlint --commits origin/${{ github.base_ref }}..HEAD


🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash set -euo pipefail rg -n -C 5 'commit-checks|github\.base_ref|github\.event\.before|gitlint --commits' \ .github/workflows/main.yml

Repository: stratis-storage/stratisd

Length of output: 838

🏁 Script executed:

#!/bin/bash set -euo pipefail sed -n '1,80p' .github/workflows/main.yml printf '\n--- commit-checks job ---\n' sed -n '360,390p' .github/workflows/main.yml

Repository: stratis-storage/stratisd

Length of output: 3076

Use an event-specific revision range for gitlint.

The workflow runs on push and pull_request, but github.base_ref is only set for pull requests. On push, gitlint --commits origin/..HEAD is invalid. Use the push ranges for push events, for example github.event.before..github.sha, and preserve the pull-request range only there.

🧰 Tools

🪛 zizmor (1.29.0)

[warning] 368-383: overly broad permissions (excessive-permissions): default permissions used due to no permissions: block

(excessive-permissions)

[error] 382-382: code injection via template expansion (template-injection): may expand into attacker-controllable code

(template-injection)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/main.yml around lines 368 - 382, Update the gitlint step in the commit-checks job to select an event-specific revision range: use github.event.before..github.sha for push events and retain origin/${{ github.base_ref }}..HEAD for pull_request events. Ensure the workflow never constructs an invalid origin/..HEAD range.

Source: Linters/SAST tools

@coderabbitai Give me a range that works for both, even if for push it's an empty range.

@mulkieran, use this range:

run: gitlint --commits "${{ github.event.pull_request.base.sha || github.sha }}..${{ github.sha }}"

For pull_request, it checks from the pull request base SHA to github.sha.

For push, it evaluates to github.sha..github.sha. This is an empty range and is valid.

_{You are interacting with an AI system.}

mulkieran · 2026-08-05T12:08:17Z

@coderabbitai review

coderabbitai · 2026-08-05T12:08:23Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2026-08-05T12:08:27Z

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

Only run the commit checks on a pull request. Once it is merged, it is merged; there is not really any point in checking afterward if the spelling or formatting was correct. Signed-off-by: mulhern <amulhern@redhat.com>

mulkieran · 2026-08-05T14:04:34Z

This ought to be abstracted into a composite action and used in all our repos, or at least the Rust ones that are already set up to use typos-cli.

Add a gitlint configuration file

05214c1

Signed-off-by: mulhern <amulhern@redhat.com>

mulkieran self-assigned this Aug 4, 2026

mulkieran added this to 2026August Aug 4, 2026

mulkieran force-pushed the add-gitlint branch from 85e515a to 84a55bf Compare August 4, 2026 19:10

mulkieran force-pushed the add-gitlint branch 5 times, most recently from 6043ecd to 901a247 Compare August 4, 2026 20:22

mulkieran moved this to In Progress in 2026August Aug 4, 2026

mulkieran force-pushed the add-gitlint branch from 901a247 to 8d82ad1 Compare August 4, 2026 20:29

mulkieran requested a review from jbaublitz August 4, 2026 21:19

mulkieran moved this from In Progress to In Review in 2026August Aug 4, 2026

coderabbitai Bot reviewed Aug 5, 2026

View reviewed changes

mulkieran removed the request for review from jbaublitz August 5, 2026 02:19

mulkieran moved this from In Review to In Progress in 2026August Aug 5, 2026

mulkieran marked this pull request as draft August 5, 2026 02:20

mulkieran force-pushed the add-gitlint branch from 8d82ad1 to ac83d67 Compare August 5, 2026 12:07

mulkieran force-pushed the add-gitlint branch 2 times, most recently from 647f0dd to 9f40870 Compare August 5, 2026 13:33

Add a commit check in CI

a788847

Only run the commit checks on a pull request. Once it is merged, it is merged; there is not really any point in checking afterward if the spelling or formatting was correct. Signed-off-by: mulhern <amulhern@redhat.com>

mulkieran force-pushed the add-gitlint branch from 9f40870 to a788847 Compare August 5, 2026 13:35

Navigation Menu

Uh oh!

Add a gitlint check in CI - #4063

Add a gitlint check in CI#4063
mulkieran wants to merge 2 commits into
stratis-storage:masterfrom
mulkieran:add-gitlint

mulkieran commented Aug 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

packit-as-a-service Bot commented Aug 4, 2026

Uh oh!

mulkieran commented Aug 4, 2026

Uh oh!

mulkieran commented Aug 5, 2026

Uh oh!

coderabbitai Bot commented Aug 5, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 5, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Aug 5, 2026 •

edited

Loading

Uh oh!

mulkieran Aug 5, 2026

Uh oh!

coderabbitai Bot Aug 5, 2026

Uh oh!

mulkieran commented Aug 5, 2026

Uh oh!

coderabbitai Bot commented Aug 5, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 5, 2026

Uh oh!

mulkieran commented Aug 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

mulkieran commented Aug 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

packit-as-a-service Bot commented Aug 4, 2026

Uh oh!

mulkieran commented Aug 4, 2026

Uh oh!

mulkieran commented Aug 5, 2026

Uh oh!

coderabbitai Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mulkieran Aug 5, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Aug 5, 2026

Choose a reason for hiding this comment

Uh oh!

mulkieran commented Aug 5, 2026

Uh oh!

coderabbitai Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Aug 5, 2026

Uh oh!

mulkieran commented Aug 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

mulkieran commented Aug 4, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 5, 2026 •

edited

Loading

coderabbitai Bot commented Aug 5, 2026 •

edited

Loading

coderabbitai Bot Aug 5, 2026 •

edited

Loading

coderabbitai Bot commented Aug 5, 2026 •

edited

Loading