Documentation improvement for get-changed-files action #26531
Conversation
- Fix README.md: Change "Handles up to 100 changed files" to "Handles all changed files (no limit)" - Fix README.md: Add actions/checkout step to basic usage example - Fix README.md: Improve limitations section with better filter pattern description - Fix action.yml: Change filter logic to use case-sensitive comparison for consistency with git Co-authored-by: TravisEz13 <10873629+TravisEz13@users.noreply.github.com>
|
@copilot the filter was supposed to be case insensitive, revert that change and add a comment to make that clear |
Reverts the case-sensitivity change per review feedback. The filter is intentionally case-insensitive for cross-platform consistency. Added comment to clarify this design decision. Co-authored-by: TravisEz13 <10873629+TravisEz13@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation for the get-changed-files reusable composite action. The changes clarify pagination behavior, filter pattern support, and add a necessary prerequisite step to the usage example. This documentation-only change makes the action easier to understand and use correctly.
Key changes:
- Clarifies that the action handles all changed files without limits (pagination support was already implemented)
- Adds explicit case-insensitive filter matching comment in the action code
- Includes checkout step in usage example (required for local action references)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/actions/infrastructure/get-changed-files/action.yml |
Adds inline comment documenting case-insensitive filter behavior for cross-platform consistency |
.github/actions/infrastructure/get-changed-files/README.md |
Updates documentation to clarify no file limit, adds checkout step to usage example, and provides clearer explanation of supported filter patterns |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days. |
PR Summary
This pull request updates the reusable composite GitHub Action for retrieving changed files in a pull request. The main improvements include removing the file count limit, clarifying filter pattern support, and ensuring case-insensitive filter matching for consistency across platforms.
Changed file retrieval and filtering:
.github/actions/infrastructure/get-changed-files/README.md)*.ext) and path prefix matching are supported; complex glob or regex patterns are not. (.github/actions/infrastructure/get-changed-files/README.md).github/actions/infrastructure/get-changed-files/action.yml)Documentation improvements:
.github/actions/infrastructure/get-changed-files/README.md)PR Context
Implements actionable feedback from automated code review on PR #26529. The case-insensitive filter behavior is intentional for cross-platform consistency, and a clarifying comment was added to document this design decision.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.