-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
workflows: added general and pre-commit github workflow
Signed-off-by: Lorenzo Vagliano
- Loading branch information
1 parent
5cae23f
commit 842c2df
Showing
6 changed files
with
114 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: Pre-Commit | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
ref: | ||
description: The reference to build | ||
type: string | ||
required: true | ||
|
||
jobs: | ||
linter: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v4 | ||
with: | ||
ref: ${{ inputs.ref }} | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.10.11" | ||
|
||
- name: Run pre-commit | ||
uses: pre-commit/action@v3.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: Pull request main | ||
|
||
on: | ||
pull_request_target: | ||
branches: [main] | ||
paths-ignore: ["docs/**"] | ||
|
||
jobs: | ||
test: | ||
uses: ./.github/workflows/test-and-build.yml | ||
with: | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
secrets: inherit | ||
|
||
pre-commit: | ||
uses: ./.github/workflows/pre-commit.yml | ||
with: | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
secrets: inherit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
[general] | ||
ignore=body-is-missing | ||
extra-path=./scripts/gitlint_rules/ | ||
debug=true | ||
verbosity=3 | ||
contrib = contrib-body-requires-signed-off-by, contrib-title-conventional-commits | ||
|
||
[title-max-length] | ||
line-length=50 | ||
|
||
[body-max-line-length] | ||
line-length=72 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
import re | ||
|
||
from gitlint.rules import CommitRule, RuleViolation | ||
|
||
# EXAMPLE GITLINT CONFIGURATION | ||
|
||
# class SignedOffBy(CommitRule): | ||
# """This rule will enforce that each commit contains a "Signed-off-by" line.""" | ||
|
||
# name = "body-requires-signed-off-by" | ||
# id = "Workflows1" | ||
|
||
# def validate(self, commit): | ||
# for line in commit.message.body: | ||
# if line.startswith("Signed-off-by"): | ||
# return | ||
|
||
# msg = "Body does not contain a 'Signed-Off-By' line" | ||
# return [RuleViolation(self.id, msg, line_nr=1)] | ||
|
||
|
||
# class ApprovedSubject(CommitRule): | ||
# """Validate subject of each commit. | ||
|
||
# This rule will enforce that each commit starts with a "module: text" format. | ||
# The 'module' can be any alphanumeric word, and the message must start with a colon followed by a space. | ||
# """ | ||
|
||
# name = "approved-subject-in-title" | ||
# id = "Workflows2" | ||
|
||
# MODULE_PATTERN = re.compile(r"^[a-zA-Z0-9_-]+: .+") | ||
|
||
# def validate(self, commit): | ||
# title = commit.message.title | ||
|
||
# if not self.MODULE_PATTERN.match(title): | ||
# msg = "Subject does not follow 'module: text' format" | ||
# return [RuleViolation(self.id, msg, line_nr=1)] | ||
|
||
# return |