diff --git a/.gitattributes b/.gitattributes
index 2c695418b..2f2247c5c 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,2 +1,8 @@
# Explicitly force LF for files
*.csv text eol=lf
+
+# Force LF line endings for text files, regardless of local core.autocrlf
+* text=auto eol=lf
+
+*.yml text eol=lf
+*.yaml text eol=lf
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/1-rule-issue.yml b/.github/ISSUE_TEMPLATE/1-rule-issue.yml
index a5307fc8f..4e6f6b704 100644
--- a/.github/ISSUE_TEMPLATE/1-rule-issue.yml
+++ b/.github/ISSUE_TEMPLATE/1-rule-issue.yml
@@ -45,4 +45,4 @@ body:
attributes:
label: Test Data
description: "If reporting a bug, attach your test data files here (CSV, Excel, etc.). You can drag and drop multiple files directly into this field."
- placeholder: Drag and drop files here, or describe the test data inline.
\ No newline at end of file
+ placeholder: Drag and drop files here, or describe the test data inline.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index ec4bb386b..3ba13e0ce 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1 +1 @@
-blank_issues_enabled: false
\ No newline at end of file
+blank_issues_enabled: false
diff --git a/.github/workflows/auto-format-yaml.yml b/.github/workflows/auto-format-yaml.yml
new file mode 100644
index 000000000..a52dd0e7b
--- /dev/null
+++ b/.github/workflows/auto-format-yaml.yml
@@ -0,0 +1,35 @@
+name: Auto-format Rule YAML
+on:
+ workflow_dispatch: {}
+jobs:
+ format-yaml:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ ref: ${{ github.head_ref || github.ref_name }}
+ fetch-depth: 0
+
+ - uses: actions/setup-python@v5
+ with:
+ python-version: "3.12"
+ - run: pip install ruamel.yaml
+
+ - name: Sort rule.yml files
+ run: python scripts/sort_yaml.py
+
+ - uses: actions/setup-node@v4
+ - name: Run Prettier to format rule.yml files
+ run: |
+ npm i prettier
+ npx prettier "Published/**/rule.yml" "Unpublished/**/rule.yml" --write
+
+ - name: Commit and push formatting fixes
+ run: |
+ git config user.name github-actions
+ git config user.email github-actions@cdisc.org
+ git add Published Unpublished
+ git diff-index --quiet HEAD || git commit -m "chore: sort and format rule.yml files"
+ git push
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 7cd64b078..4edb33086 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -97,4 +97,4 @@ jobs:
- name: Push
if: steps.newdirs.outputs.HAS_NEW_DIRS == 'true'
run: |
- git push
\ No newline at end of file
+ git push
diff --git a/.github/workflows/submodule_update.yml b/.github/workflows/submodule_update.yml
index f551a59c2..f07d3ee06 100644
--- a/.github/workflows/submodule_update.yml
+++ b/.github/workflows/submodule_update.yml
@@ -33,4 +33,4 @@ jobs:
body: |
Automated update of the `engine` submodule to the latest commit on `cdisc-rules-engine/main`.
branch: auto/update-engine-submodule
- base: main
\ No newline at end of file
+ base: main
diff --git a/.github/workflows/validate-rule-contributions.yml b/.github/workflows/validate-rule-contributions.yml
index a9cd1fc22..1316aef8e 100644
--- a/.github/workflows/validate-rule-contributions.yml
+++ b/.github/workflows/validate-rule-contributions.yml
@@ -3,7 +3,7 @@ name: Validate Rule Contributions
on:
pull_request:
paths:
- - 'Unpublished/**'
+ - "Unpublished/**"
types: [opened, synchronize, reopened]
workflow_dispatch: {}
@@ -27,7 +27,7 @@ jobs:
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
- python-version: '3.12'
+ python-version: "3.12"
- name: Install engine dependencies
run: |
diff --git a/.github/workflows/validate-yaml-format.yml b/.github/workflows/validate-yaml-format.yml
index 8afa3825b..74e5012e6 100644
--- a/.github/workflows/validate-yaml-format.yml
+++ b/.github/workflows/validate-yaml-format.yml
@@ -11,17 +11,27 @@ jobs:
runs-on: ubuntu-latest
permissions:
contents: read
+ issues: write
pull-requests: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
+
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- run: pip install ruamel.yaml
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: "20"
+ - name: Install Prettier
+ run: npm install -g prettier
+
- name: Detect changed rule.yml files
id: changed-files
run: |
@@ -39,47 +49,116 @@ jobs:
echo "has_files=true" >> $GITHUB_OUTPUT
echo "$FILES" > /tmp/changed_rule_files.txt
fi
- - name: Check YAML sorting and formatting
- id: format-check
+
+ - name: Check YAML sorting
+ id: sort-check
if: steps.changed-files.outputs.has_files == 'true'
run: |
- FILES=$(cat /tmp/changed_rule_files.txt | tr '\n' ' ')
- python scripts/sort_yaml.py --check $FILES
+ mapfile -t FILES < /tmp/changed_rule_files.txt
+ python scripts/sort_yaml.py --check "${FILES[@]}" 2> /tmp/sort_stderr.txt
continue-on-error: true
- - name: Post format check result to PR
+
+ - name: Check Prettier formatting
+ id: prettier-check
+ if: steps.changed-files.outputs.has_files == 'true'
+ run: |
+ : > /tmp/prettier_unformatted.txt
+ while read -r f; do
+ [ -z "$f" ] && continue
+ if ! prettier --check "$f" > /dev/null 2>&1; then
+ echo " $f" >> /tmp/prettier_unformatted.txt
+ fi
+ done < /tmp/changed_rule_files.txt
+ if [ -s /tmp/prettier_unformatted.txt ]; then
+ echo "passed=false" >> $GITHUB_OUTPUT
+ else
+ echo "passed=true" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Post result to PR
if: always() && github.event_name == 'pull_request' && steps.changed-files.outputs.has_files == 'true'
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
- const outcome = '${{ steps.format-check.outcome }}';
+ const fs = require('fs');
+
+ function truncatedList(path, maxChars = 3000) {
+ let raw = '';
+ try { raw = fs.readFileSync(path, 'utf8'); } catch (e) { return ''; }
+ const lines = raw.split('\n').filter(l => l.trim().length > 0);
+ let out = [];
+ let total = 0;
+ for (const line of lines) {
+ if (total + line.length > maxChars) {
+ out.push(`...and ${lines.length - out.length} more`);
+ break;
+ }
+ out.push(line);
+ total += line.length + 1;
+ }
+ return out.join('\n');
+ }
+
+ const sortOk = '${{ steps.sort-check.outcome }}' === 'success';
+ const prettierOk = '${{ steps.prettier-check.outputs.passed }}' === 'true';
const marker = '';
let body = marker + '\n';
- if (outcome === 'success') {
+
+ if (sortOk && prettierOk) {
body += '## \u2705 YAML Format Check Passed\n\nAll changed `rule.yml` files are correctly sorted and formatted.';
} else {
body += '## \u274c YAML Format Check Failed\n\n';
- body += 'One or more `rule.yml` files are not correctly sorted/formatted alphabetically by key.\n\n';
- body += 'Run the following command locally to fix them:\n\n```bash\npython scripts/sort_yaml.py\n```\n\nThen commit and push.';
+ if (!sortOk) {
+ const sortList = truncatedList('/tmp/sort_stderr.txt');
+ body += '**Sorting issue** — one or more `rule.yml` files are not sorted alphabetically by key.\n\n';
+ body += 'Run the following command locally to fix them:\n\n```bash\npython scripts/sort_yaml.py\n```\n\n';
+ if (sortList) body += 'Details
\n\n```\n' + sortList + '\n```\n