Skip to content

Conversation

@lachlan-robinson
Copy link
Contributor

Description

This workflow introduces an automated validation step for pull requests that checks all changed filenames for the presence of a colon (:). If any filenames contain a colon, the workflow will:

  1. Fail the pull request check, preventing merge until the issue is resolved.
  2. Post a comment directly on the pull request, listing the offending filenames and instructing contributors to rename them.

This ensures filename conventions are enforced consistently across the repository and prevents potential issues with file handling on different systems.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (update or new)

How Has This Been Tested?

The workflow was tested by opening a pull request with files containing : in their names.

  • When such files were detected, the workflow failed and a comment was automatically posted to the PR.
  • When no such files were present, the workflow passed successfully and no comment was left.

Testing Checklist

  • Tested on pull requests with valid filenames
  • Tested on pull requests with filenames containing :
  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

@netlify
Copy link

netlify bot commented Aug 25, 2025

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit 22d6f85
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/68ac2cd7cf14760007400c13
😎 Deploy Preview https://deploy-preview-53--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@ibi420 ibi420 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @lachlan-robinson,

Thank you for this addition; it’s a very welcome improvement, as it helps prevent Git from breaking on Windows. I’ve reviewed the implementation and am very happy with how it’s been done.

I appreciate the opportunity to review your work and great job on this

Copy link
Contributor

@martindolores martindolores left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Well-written, and enforces safe filenames.🤘

Copy link

@AB-Deakin AB-Deakin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes checked and approved by Alex Brown 14/09/2025 code looks great and will be a welcome update to help future PRs work correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants