Skip to content

docs: add Ecosystem page featuring Sawchain and fix Windows test compatibility#2743

Open
LoveChauhan-18 wants to merge 2 commits into
kyverno:mainfrom
LoveChauhan-18:main
Open

docs: add Ecosystem page featuring Sawchain and fix Windows test compatibility#2743
LoveChauhan-18 wants to merge 2 commits into
kyverno:mainfrom
LoveChauhan-18:main

Conversation

@LoveChauhan-18

Copy link
Copy Markdown

Explanation

This PR introduces two sets of improvements:

  1. Ecosystem Documentation: Adds Sawchain (an open-source Go testing library by Guidewire that builds on Chainsaw's public packages) as a featured ecosystem project in the documentation and resources (addressing [Question] Add Sawchain to ecosystem/related projects #2681).
  2. Windows Compatibility: Fixes several test failures on Windows environments caused by line ending differences, Unix-specific file permissions (chmod), and absolute path assertions.

Related issue

Fixes #2681

Proposed Changes

Documentation (Sawchain Integration)

  • [NEW] website/docs/community/ecosystem.md: A new page outlining Chainsaw's public package architecture and highlighting Sawchain, with links to its repository and blog post.
  • [MODIFY] website/mkdocs.yaml: Registered the new "Ecosystem & Related Projects" page under the "Community" navigation section.
  • [MODIFY] website/docs/quick-start/resources.md: Appended links to the new Ecosystem page.
  • [MODIFY] README.md: Added a "Related Projects & Ecosystem" section referencing Sawchain.

Test Environment (Windows Compatibility Fixes)

  • [MODIFY] .gitattributes: Configured automatic LF normalization for YAML files to prevent CRLF test mismatch.
  • [MODIFY] pkg/utils/yaml/yaml_test.go: Added string normalization (strings.ReplaceAll(..., "\r\n", "\n")) before raw YAML multi-line comparisons.
  • [MODIFY] pkg/runner/names/test_test.go: Wrapped file path assertions in filepath.FromSlash to adapt to Windows backslashes (\).
  • [MODIFY] pkg/utils/fs/discover_test.go: Instructed the directory permissions test (TestDiscover/unreadable_directory) to skip on Windows because POSIX chmod behavior is not natively supported by the Windows OS file system.

Checklist

  • I have read the contributing guidelines.
  • I have read the PR documentation guide and followed the process including adding proof manifests to this PR. (Exempt: Documentation & internal test compatibility fixes only)
  • This is a bug fix and I have added unit tests that prove my fix is effective. (Windows test environment compatibility verified locally)

- Add .gitattributes to enforce LF line endings for YAML/YML files
- Normalize CRLF to LF in yaml_test.go before string comparisons
- Use filepath.FromSlash in runner/names/test_test.go for portable path assertions
- Skip POSIX chmod-based unreadable directory test on Windows in fs/discover_test.go

Signed-off-by: Love Kumar Chauhan <lovechauhan6564@gmail.com>
Signed-off-by: Love Kumar Chauhan <lovechauhan6564@gmail.com>
@LoveChauhan-18 LoveChauhan-18 requested a review from a team as a code owner June 17, 2026 14:49
@LoveChauhan-18

Copy link
Copy Markdown
Author

Hi @eolatham,

I have completed the implementation for issue #2681 and opened the Pull Request!

Here is a summary of the changes:

  1. Ecosystem Page & Resources: Added a new "Ecosystem & Related Projects" page detailing the Sawchain library (along with links to its repository and Guidewire blog post), and integrated links to it in README.md and the Quick Start resource page.
  2. Windows Test Compatibility: Resolved some pre-existing path, line-ending, and permission assertion issues so that all Go tests now pass cleanly on Windows environments.
  3. Validation: Compiled the docs locally using mkdocs build to ensure all links and rendering (including admonitions) are correct.

Both commits have been conventional-commit formatted and signed off. Please let me know if you have any feedback or if anything else is needed!

@eolatham eolatham left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thanks @LoveChauhan-18 — This documents #2681 wonderfully!

I will defer to a maintainer to vet the test fixes that are grouped in here.

@LoveChauhan-18

Copy link
Copy Markdown
Author

Thank you for the review and approval! I appreciate the feedback. I'll wait for maintainer review and workflow approval.

@LoveChauhan-18

Copy link
Copy Markdown
Author

Hi, @eolatham , Please review the PR once. I am waiting for your approval!

@eolatham

Copy link
Copy Markdown

@LoveChauhan-18 I approved, but unfortunately I'm not a maintainer so I can't merge.
@eddycharly could you please take a look?

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.

[Question] Add Sawchain to ecosystem/related projects

2 participants