Skip to content

Commit a86efc5

Browse files
committed
Update message
1 parent 6ad8bea commit a86efc5

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

.github/workflows/check-url-changes.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ jobs:
1616

1717
- name: Identify deleted and renamed files
1818
run: |
19-
# Store deleted files
20-
DELETED_FILES=$(git diff --name-status origin/master ${{ github.event.pull_request.head.sha }} | grep '^D' | cut -f2- || true)
19+
# Store deleted markdown files
20+
DELETED_FILES=$(git diff --name-status origin/master ${{ github.event.pull_request.head.sha }} | grep '^D.*\.md$' | cut -f2- || true)
2121
echo "DELETED_FILES<<EOF" >> $GITHUB_ENV
2222
echo "$DELETED_FILES" >> $GITHUB_ENV
2323
echo "EOF" >> $GITHUB_ENV
2424
25-
# Store renamed files
26-
RENAMED_FILES=$(git diff --name-status origin/master ${{ github.event.pull_request.head.sha }} | grep '^R' | awk '{print $2 " -> " $3}' || true)
25+
# Store renamed markdown files
26+
RENAMED_FILES=$(git diff --name-status origin/master ${{ github.event.pull_request.head.sha }} | grep '^R.*\.md$' | awk '{print $2 " -> " $3}' || true)
2727
echo "RENAMED_FILES<<EOF" >> $GITHUB_ENV
2828
echo "$RENAMED_FILES" >> $GITHUB_ENV
2929
echo "EOF" >> $GITHUB_ENV
@@ -38,7 +38,7 @@ jobs:
3838
# Print to console for logging
3939
echo "Deleted files:"
4040
echo "$DELETED_FILES"
41-
echo -e "\nRenamed files:"
41+
echo -e "\nRenamed/Moved files:"
4242
echo "$RENAMED_FILES"
4343
4444
- name: Post PR warning
@@ -52,17 +52,17 @@ jobs:
5252
const deletedFiles = `${process.env.DELETED_FILES}`.trim();
5353
const renamedFiles = `${process.env.RENAMED_FILES}`.trim();
5454
55-
let message = `⚠️ **Documentation Warning**\n\n`;
55+
let message = `🔍 **Documentation URL Checker**\n\nThis PR modifies documentation files in ways that could potentially create broken links.\n\n`;
5656
5757
if (deletedFiles) {
5858
message += `**Deleted files:**\n\`\`\`\n${deletedFiles}\n\`\`\`\n\n`;
5959
}
6060
6161
if (renamedFiles) {
62-
message += `**Renamed files:**\n\`\`\`\n${renamedFiles}\n\`\`\`\n\n`;
62+
message += `**Renamed/Moved files:**\n\`\`\`\n${renamedFiles}\n\`\`\`\n\n`;
6363
}
6464
65-
message += `Please verify these changes before merging.`;
65+
message += `🚨 Please review these changes carefully 🚨\n\n If not handled properly, broken links (404 errors) could appear. To maintain a smooth user experience, consider:\n- Adding redirects in the \`mkdocs.yml\` file from the old URLs to the new ones\n- Updating internal references to these files`;
6666
6767
github.rest.issues.createComment({
6868
owner: repo.owner,

0 commit comments

Comments
 (0)