⚙️ [Maintenance]: Documentation index checks now work across line endings - #79
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 25, 2026 16:24
View session
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation index generation/check script to make “stale index” detection independent of the checkout’s LF vs CRLF line endings, preventing false CI failures across Windows/Linux working copies.
Changes:
- Normalize line endings only for comparison when determining whether an index is stale, while preserving the index file’s existing newline style when rendering/writing.
- Update index table generation to join lines using the detected newline sequence instead of forcing LF.
- Add Pester tests covering unchanged, stale, and repaired indexes under both LF and CRLF fixtures.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
tests/Update-DocumentationIndex.Tests.ps1 |
Adds fixture-based Pester coverage for LF/CRLF behavior in both -Check and update modes. |
.github/scripts/Update-DocumentationIndex.ps1 |
Detects and preserves per-file newline style while comparing content in a newline-normalized form to avoid false stale detections. |
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
July 25, 2026 16:26
Marius Storhaug (MariusStorhaug)
enabled auto-merge (squash)
July 25, 2026 16:26
Marius Storhaug (MariusStorhaug)
disabled auto-merge
July 25, 2026 16:30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation index checks now behave consistently across Windows and Linux working copies, avoiding false stale-index failures caused only by checkout line endings.
Fixed: Index checks no longer depend on checkout line endings
Current generated indexes pass validation with either LF or CRLF line endings. Real table-content drift still fails validation, and update mode retains one consistent existing newline style for the file.
Technical Details
Related issues