Skip to content

Adding test to ensure that any added role gets a README file#169

Open
jwlodek wants to merge 2 commits intoNSLS2:mainfrom
jwlodek:add-test-to-ensure-readmes-exist
Open

Adding test to ensure that any added role gets a README file#169
jwlodek wants to merge 2 commits intoNSLS2:mainfrom
jwlodek:add-test-to-ensure-readmes-exist

Conversation

@jwlodek
Copy link
Collaborator

@jwlodek jwlodek commented Feb 11, 2026

No description provided.

Copilot AI review requested due to automatic review settings February 11, 2026 14:52
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a new test to ensure that every device role has a README.md file, modernizes the test_device_roles.py file to use pathlib instead of os, and adds configuration updates to exclude the collections/ansible_collections/ directory from various linters and formatters. A new GitHub Actions workflow is also introduced to validate configurations.

Changes:

  • Added test to verify each device role has a README.md file
  • Modernized test_device_roles.py to use pathlib instead of os module
  • Added collections/ansible_collections/ exclusions to ruff.toml, .pre-commit-config.yaml, and .ansible-lint
  • Created new GitHub Actions workflow for validating module vars, device roles, and example configs
  • Added testpaths configuration to pytest.ini and indent-width to ruff.toml

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tests/test_device_roles.py Modernized to use pathlib, renamed parameters to device_role_name, and added test for README.md existence
ruff.toml Added exclusion for collections/ansible_collections/ and indent-width configuration
pytest.ini Added testpaths configuration to specify tests directory
.pre-commit-config.yaml Added global exclusion pattern for collections/ansible_collections/
.ansible-lint Added collections/ansible_collections/ to exclude_paths
.github/workflows/validate_configs.yml New workflow file with three sequential jobs for validating different configuration types

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

2 participants