Skip to content

Dev #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lhw2002426 wants to merge 5 commits into from
Closed

Dev #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e11b48d
test(auth): 2025.7.22
Jul 22, 2025
f3923a0
ci: add rule for pr commit message
ken4647 Jul 22, 2025
eed0a94
test(auth): add blank
Jul 22, 2025
0891d53
7.23 test
Jul 20, 2025
1b86be3
Merge branch 'dev' into dev
lhw2002426 Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 69 additions & 63 deletions .github/workflows/commit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,103 +2,109 @@ name: Custom Commit Message Validator

on:
pull_request:
types: [opened, reopened, synchronize] # Triggers on PR open, reopen, or new commits pushed to the PR branch
types: [opened, reopened, synchronize]

jobs:
validate_commit_messages:
runs-on: ubuntu-latest # Specifies the runner environment
validate_COMMIT_MESSAGEs:
runs-on: ubuntu-latest

permissions:
contents: read # Needed for checkout
pull-requests: read # Needed to fetch PR details and commit SHAs
contents: read
pull-requests: read

steps:
- name: Checkout Repository
uses: actions/checkout@v4 # Action to checkout your repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetches the entire history for git log operations. Crucial for retrieving full commit messages.
fetch-depth: 0

- name: Get PR Commits SHAs
id: get_pr_commits
run: |
# Use GitHub CLI to get all commit SHAs associated with the current Pull Request.
# This robustly gets the commits that are part of the PR's changes.
# The jq filter extracts the 'oid' (Object ID, which is the SHA) of each commit.
# Fetch all commit SHAs associated with the current Pull Request
PR_COMMIT_SHAS=$(gh pr view ${{ github.event.pull_request.number }} --json commits --jq '[.commits[].oid] | join(" ")')

# Output the SHAs as a space-separated string.
# This variable will be accessible via steps.get_pr_commits.outputs.PR_COMMITS_LIST
echo "PR_COMMITS_LIST=${PR_COMMIT_SHAS}" >> "$GITHUB_OUTPUT"
env:
# GITHUB_TOKEN is automatically provided by GitHub Actions with sufficient permissions.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Validate Each Commit Message
env:
TARGET_DATE: "2025-07-22" # Only check commits after this date
SKIP_KEYWORDS: "Merge,Revert,Release" # Comma-separated keywords to skip validation
run: |
# Read the space-separated list of commit SHAs into a Bash array.
# IFS (Internal Field Separator) is set to space to split the string correctly.
# Read commit SHAs into array
IFS=' ' read -r -a commit_shas <<< "${{ steps.get_pr_commits.outputs.PR_COMMITS_LIST }}"

# Initialize a flag to track if any commit fails validation.
has_validation_failed=false

# Loop through each commit SHA.
# Convert skip keywords to array
IFS=',' read -r -a skip_keywords <<< "$SKIP_KEYWORDS"

for commit_sha in "${commit_shas[@]}"; do
echo "--- Checking commit: ${commit_sha} ---"

# Get the full commit message (subject + body).
# --format=%B gets the raw body (subject and body).
# -n 1 limits to the latest commit for the given SHA.
commit_message=$(git log --format=%B -n 1 "${commit_sha}")

# Get commit timestamps for date filtering
COMMIT_DATE_UNIX=$(git log -n 1 --format=%at "${commit_sha}")
TARGET_DATE_UNIX=$(date -d "${TARGET_DATE}" +"%s")
COMMIT_DATE_HUMAN=$(git log -n 1 --format=%ad --date=iso-strict "${commit_sha}")
# Skip older commits
if (( COMMIT_DATE_UNIX < TARGET_DATE_UNIX )); then
echo "Skipping commit ${commit_sha} (Date: ${COMMIT_DATE_HUMAN}) as it is older than ${TARGET_DATE}."
continue
fi
echo "Processing commit ${commit_sha} (Date: ${COMMIT_DATE_HUMAN}) as it is on or after ${TARGET_DATE}."
COMMIT_MESSAGE=$(git log --format=%B -n 1 "${commit_sha}")
echo "Message content:"
echo "${commit_message}"
echo "" # Add a newline for readability

# --- Validation Logic ---

# 1. Check for Conventional Commit format (type(scope)!: subject)
# This regex allows for an optional scope and an optional breaking change marker (!).
# Common types: feat, fix, docs, chore, style, refactor, perf, test, build, ci, revert
if [[ ! "${commit_message}" =~ ^(feat|fix|docs|chore|style|refactor|perf|test|build|ci|revert)(\([a-zA-Z0-9_-]+\))?(!?): ]]; then
echo "::error file=COMMIT_MESSAGE::Commit ${commit_sha} does not start with a conventional commit type (e.g., 'feat:', 'fix:'). Message: '${commit_message}'"
echo "${COMMIT_MESSAGE}"
echo ""
# Check for skip keywords
skip_this_commit=false
for keyword in "${skip_keywords[@]}"; do
# Trim whitespace from keyword
trimmed_keyword=$(echo "$keyword" | xargs)

if [[ -n "$trimmed_keyword" ]] &&
[[ "${COMMIT_MESSAGE}" == *"$trimmed_keyword"* ]]; then
echo "Skipping validation for commit ${commit_sha} due to skip keyword: ${trimmed_keyword}"
skip_this_commit=true
break
fi
done

if [ "$skip_this_commit" = true ]; then
continue
fi
# --- Validation Logic Start ---

# 1. Check Conventional Commit format
if [[ ! "${COMMIT_MESSAGE}" =~ ^(feat|fix|docs|chore|style|refactor|perf|test|build|ci|revert)(\([a-zA-Z0-9_-]+\))?(!?): ]]; then
echo "::error file=COMMIT_MESSAGE::Commit ${commit_sha} does not start with a conventional commit type. Message: '${COMMIT_MESSAGE}'"
has_validation_failed=true
continue # Move to the next commit
continue
fi

# Extract the first line (subject) for further checks.
commit_subject=$(echo "${commit_message}" | head -n 1)

# 2. Check subject line length (e.g., max 72 characters)
# Extract commit subject (first line)
commit_subject=$(echo "${COMMIT_MESSAGE}" | head -n 1)
# 2. NEW: Check minimum subject length (15 characters)
if [[ ${#commit_subject} -lt 15 ]]; then
echo "::error file=COMMIT_MESSAGE::Commit ${commit_sha} subject is too short (min 15 characters). Length: ${#commit_subject}. Subject: '${commit_subject}'"
has_validation_failed=true
continue
fi
# 3. Check maximum subject length (72 characters)
if [[ ${#commit_subject} -gt 72 ]]; then
echo "::warning file=COMMIT_MESSAGE::Commit ${commit_sha} subject line exceeds 72 characters. Length: ${#commit_subject}. Subject: '${commit_subject}'"
# This is a warning, not a failure, adjust as needed.
fi

# 3. Check for empty line between subject and body (if body exists)
# Check if there's more than just the subject line.
if [[ $(echo "${commit_message}" | wc -l) -gt 1 ]]; then
# Check if the second line is empty.
# Use awk to get the second line and trim whitespace.
second_line=$(echo "${commit_message}" | awk 'NR==2 {print}' | xargs)
if [[ -n "${second_line}" ]]; then # If the second line is NOT empty
echo "::error file=COMMIT_MESSAGE::Commit ${commit_sha} is missing an empty line between the subject and body. Message: '${commit_message}'"
# 4. Check empty line between subject and body
if [[ $(echo "${COMMIT_MESSAGE}" | wc -l) -gt 1 ]]; then
second_line=$(echo "${COMMIT_MESSAGE}" | awk 'NR==2 {print}' | xargs)
if [[ -n "${second_line}" ]]; then
echo "::error file=COMMIT_MESSAGE::Commit ${commit_sha} is missing an empty line between subject and body. Message: '${COMMIT_MESSAGE}'"
has_validation_failed=true
continue
fi
fi

# Add more custom validation rules here as needed:
# - Subject capitalization (e.g., must be lowercase)
# - Subject must not end with a period
# - Body line length limits
# - Required body content for certain types (e.g., 'fix:' requires a 'Fixes #ISSUE' line)

done # End of commit loop

# If any commit failed validation, exit with a non-zero status to fail the job.
done
# Fail job if any validation errors occurred
if [ "$has_validation_failed" = true ]; then
echo "::error::One or more commit messages failed validation. Please review the errors above."
exit 1
fi

echo "All commit messages in the PR passed validation."
echo "All relevant commit messages in the PR passed validation."
1 change: 1 addition & 0 deletions apps/c/RuxOS_Test
Open in desktop
Submodule RuxOS_Test added at 15c4fe
Loading