Workflow for checking on duplicate titles in class.txt.json

This commit is contained in:
2026-04-08 12:40:25 +00:00
parent cf38dbaabb
commit ca8a03a437
7 changed files with 282 additions and 3 deletions

View File

@ -0,0 +1,81 @@
# .gitea/workflows/class-txt-check.yml
name: CLASS.TXT.json Check
on:
pull_request:
types: [opened, reopened, synchronize, edited]
permissions:
contents: read
pull-requests: write
jobs:
class-txt-check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Get changed CLASS.TXT.json files
id: changed-files
run: |
BASE_SHA="${{ gitea.event.pull_request.base.sha }}"
changed=$(git diff --name-only ${BASE_SHA}...HEAD | grep -E 'CLASS\.TXT\.json$' | tr '\n' ' ' || true)
echo "files=$changed" >> $GITHUB_OUTPUT
echo "CHANGED_FILES=$changed" >> $GITHUB_ENV
echo "Changed CLASS.TXT.json files: $changed"
- name: Run duplicate title check
id: class-check
run: |
python3 .gitea/workflows/helpers/class-txt-check.py
- name: Comment on PR with violations
if: failure() && steps.class-check.outcome == 'failure'
env:
GITEA_SERVER_URL: ${{ gitea.server_url }}
REPO: ${{ gitea.repository }}
PR_NUMBER: ${{ gitea.event.pull_request.number }}
TOKEN: ${{ gitea.token }}
run: |
set -euo pipefail
# Ensure URL starts with http
if [[ ! "${GITEA_SERVER_URL}" =~ ^https?:// ]]; then
GITEA_SERVER_URL="http://${GITEA_SERVER_URL}"
echo "Added http:// prefix to URL"
fi
# Generate comment message
MSG=$(python3 .gitea/workflows/helpers/class-comment.py)
echo "$MSG"
# Extract body from JSON
BODY=$(echo "$MSG" | python3 -c "import sys, json; print(json.load(sys.stdin)['body'])")
# Build the full URL
FULL_URL="${GITEA_SERVER_URL}/api/v1/repos/${REPO}/issues/${PR_NUMBER}/comments"
echo "Posting comment to: ${FULL_URL}"
# Comment on PR
curl -sS -X POST \
-H "Authorization: token ${TOKEN}" \
-H "Content-Type: application/json" \
"${FULL_URL}" \
-d "$(echo "$BODY" | python3 -c "import sys, json; print(json.dumps({'body': sys.stdin.read()}))")"
- name: Final status
if: always()
run: |
if [ -f violations.json ]; then
echo "::error::CLASS.TXT.json check failed. See previous step for details."
exit 1
fi

View File

@ -39,7 +39,7 @@ jobs:
- name: Run underscore check
id: underscore-check
run: |
python3 .gitea/workflows/underscore-check.py
python3 .gitea/workflows/helpers/underscore-check.py
- name: Comment on PR with violations
if: failure() && steps.underscore-check.outcome == 'failure'
@ -58,7 +58,7 @@ jobs:
fi
# Generate comment message
MSG=$(python3 .gitea/workflows/generate-comment.py)
MSG=$(python3 .gitea/workflows/helpers/underscore-comment.py)
echo "$MSG"
# Extract body from JSON

View File

@ -0,0 +1,58 @@
#!/usr/bin/env python3
"""Generate PR comment from CLASS.TXT.json violations."""
import json
import sys
def main():
try:
with open("violations.json", "r") as f:
violations = json.load(f)
except Exception:
violations = []
if not violations:
print(json.dumps({"body": "No violations to report"}))
sys.exit(0)
# Group violations by file
by_file = {}
for v in violations:
key = v["file"]
if key not in by_file:
by_file[key] = []
by_file[key].append(v)
# Build message
lines = [
"❌ **Duplicate title detected in CLASS.TXT.json**",
"",
"Found child documents with duplicate titles under the same parent:",
"",
]
for filepath, file_violations in by_file.items():
lines.append(f"**{filepath}:**")
for v in file_violations:
parent_code = v["parent_code"]
parent_title = v["parent_title"]
duplicate_title = v["duplicate_title"]
codes = v["codes"]
lines.append(f" - Parent: `{parent_title}` (code: `{parent_code}`)")
lines.append(f" Duplicate title: `{duplicate_title}`")
for code in codes:
lines.append(f" - Document code: `{code}`")
lines.append("")
lines.append(
"**Please ensure all child documents under the same parent have unique titles.**"
)
message = "\n".join(lines)
print(json.dumps({"body": message}))
if __name__ == "__main__":
main()

File diff suppressed because it is too large Load Diff

View File

@ -515,7 +515,7 @@
{
"desc":"Meaning: Request throttling policy.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
"product_code":"apig",
"title":"x-apigateway-ratelimit",
"title":"x-apigateway-ratelimits",
"uri":"apig_03_0098.html",
"doc_type":"usermanual",
"p_code":"43",