martin/ProxmoxVE
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE synced 2025-01-10 19:05:09 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Validate and auto-fix script formatting

Browse Source
This commit is contained in:
CanbiZ 2025-01-09 15:36:40 +01:00 committed by GitHub
parent 19e7751fb9
commit 6b183c9e4e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 21 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
.github/workflows/validate-formatting.yaml vendored
View File

@ -1,4 +1,4 @@
name: Validate script formatting name: Validate and auto-fix script formatting
on: on:
push: push:
@ -11,9 +11,10 @@ on:
jobs: jobs:
shfmt: shfmt:
name: Check changed files name: Check and fix formatting
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: write
pull-requests: write pull-requests: write
steps: steps:
@ -32,13 +33,13 @@ jobs:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 # Ensure the full history is fetched for accurate diffing fetch-depth: 0
ref: ${{ github.event_name == 'pull_request_target' && fromJSON(steps.pr.outputs.result).merge_commit_sha || '' }} ref: ${{ github.event_name == 'pull_request_target' && fromJSON(steps.pr.outputs.result).merge_commit_sha || '' }}
- name: Get changed files - name: Get changed files
id: changed-files id: changed-files
run: | run: |
if ${{ github.event_name == 'pull_request_target' }}; then if [ "${{ github.event_name }}" == "pull_request_target" ]; then
echo "files=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ steps.pr.outputs.result && fromJSON(steps.pr.outputs.result).merge_commit_sha }} | grep -E '\.(sh|func)$' | xargs)" >> $GITHUB_OUTPUT echo "files=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ steps.pr.outputs.result && fromJSON(steps.pr.outputs.result).merge_commit_sha }} | grep -E '\.(sh|func)$' | xargs)" >> $GITHUB_OUTPUT
else else
echo "files=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }} | grep -E '\.(sh|func)$' | xargs)" >> $GITHUB_OUTPUT echo "files=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }} | grep -E '\.(sh|func)$' | xargs)" >> $GITHUB_OUTPUT
@ -54,42 +55,36 @@ jobs:
go install mvdan.cc/sh/v3/cmd/shfmt@latest go install mvdan.cc/sh/v3/cmd/shfmt@latest
echo "$GOPATH/bin" >> $GITHUB_PATH echo "$GOPATH/bin" >> $GITHUB_PATH
- name: Run shfmt - name: Fix formatting
if: steps.changed-files.outputs.files != '' if: steps.changed-files.outputs.files != ''
id: shfmt
run: | run: |
set +e shfmt -w ${{ steps.changed-files.outputs.files }}
shfmt_output=$(shfmt -d ${{ steps.changed-files.outputs.files }}) - name: Commit and push changes
if [[ $? -eq 0 ]]; then if: steps.changed-files.outputs.files != '' && github.event_name == 'pull_request_target'
exit 0 run: |
else git config user.name "github-actions[bot]"
echo "diff=\"$(echo -n "$shfmt_output" | base64 -w 0)\"" >> $GITHUB_OUTPUT git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
printf "%s" "$shfmt_output" git add ${{ steps.changed-files.outputs.files }}
exit 1 git commit -m "chore: auto-fix formatting issues"
fi git push
- name: Post comment with results - name: Post comment with results
if: always() && steps.changed-files.outputs.files != '' && github.event_name == 'pull_request_target' if: always() && github.event_name == 'pull_request_target'
uses: actions/github-script@v7 uses: actions/github-script@v7
with: with:
script: | script: |
const result = "${{ job.status }}" === "success" ? "success" : "failure"; const result = "${{ job.status }}" === "success" ? "success" : "failure";
const diff = Buffer.from(
${{ steps.shfmt.outputs.diff }},
"base64",
).toString();
const issueNumber = context.payload.pull_request const issueNumber = context.payload.pull_request
? context.payload.pull_request.number ? context.payload.pull_request.number
: null; : null;
const commentIdentifier = "validate-formatting"; const commentIdentifier = "validate-formatting";
let newCommentBody = `<!-- ${commentIdentifier}-start -->\n### Script formatting\n\n`; let newCommentBody = `<!-- ${commentIdentifier}-start -->\n### Script Formatting Results\n\n`;
if (result === "failure") { if (result === "failure") {
newCommentBody += newCommentBody += `:x: Formatting issues were found and automatically fixed.\n`;
`:x: We found issues in the formatting of the following changed files:\n\n\`\`\`diff\n${diff}\n\`\`\`\n`;
} else { } else {
newCommentBody += `:rocket: All changed shell scripts are formatted correctly!\n`; newCommentBody += `:rocket: All scripts are properly formatted!\n`;
} }
newCommentBody += `\n\n<!-- ${commentIdentifier}-end -->`; newCommentBody += `\n\n<!-- ${commentIdentifier}-end -->`;
@ -101,20 +96,11 @@ jobs:
}); });
const existingComment = comments.find( const existingComment = comments.find(
(comment) => comment.user.login === "github-actions[bot]", (comment) => comment.user.login === "github-actions[bot]" &&
comment.body.includes(commentIdentifier)
); );
if (existingComment) { if (existingComment) {
if (existingComment.body.includes(commentIdentifier)) {
const re = new RegExp(
String.raw`<!-- ${commentIdentifier}-start -->[\s\S]*?<!-- ${commentIdentifier}-end -->`,
"",
);
newCommentBody = existingComment.body.replace(re, newCommentBody);
} else {
newCommentBody = existingComment.body + "\n\n---\n\n" + newCommentBody;
}
await github.rest.issues.updateComment({ await github.rest.issues.updateComment({
...context.repo, ...context.repo,
comment_id: existingComment.id, comment_id: existingComment.id,
@ -127,4 +113,3 @@ jobs:
body: newCommentBody, body: newCommentBody,
}); });
} }
}