-
Notifications
You must be signed in to change notification settings - Fork 84
feat: Add HIDE_ITEMS_LIST environment variable to hide individual items table in reports #612
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: zkoppert <[email protected]>
@copilot please run prettier on the markdown files to fix the linting issues |
Co-authored-by: zkoppert <[email protected]>
Done! Ran prettier on README.md and fixed the trailing whitespace issue. All markdown files now pass prettier formatting checks. |
There was a problem hiding this 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 environment variable HIDE_ITEMS_LIST
that allows users to hide the individual items table in the generated report while keeping all summary metrics visible. This addresses management's need to view only aggregated metrics without detailed issue/PR listings.
- Add
HIDE_ITEMS_LIST
environment variable with default value offalse
for backward compatibility - Conditionally skip rendering the individual items table when the variable is set to
true
- Add comprehensive tests and update documentation
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
config.py | Adds the new hide_items_list boolean attribute to EnvVars class and environment variable reading logic |
markdown_writer.py | Implements conditional logic to skip writing the items table when hide_items_list is True |
test_config.py | Adds test to verify the new environment variable is properly read and updates existing test expectations |
test_markdown_writer.py | Adds comprehensive test to verify the items table is hidden when HIDE_ITEMS_LIST=true |
README.md | Documents the new environment variable with description and default value |
Signed-off-by: Zack Koppert <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Zack Koppert <[email protected]>
This reverts commit ce4b482.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested locally! Works great!
Signed-off-by: Zack Koppert <[email protected]>
Add HIDE_ITEMS_LIST environment variable to hide issue/PR details table
Summary
Successfully implemented a new environment variable
HIDE_ITEMS_LIST
that allows users to hide the individual items table in the generated report while keeping all summary metrics visible. This addresses the feature request to provide management with only aggregated metrics without the detailed list of issues/PRs.Implementation Checklist
hide_items_list
boolean attribute toEnvVars
class inconfig.py
HIDE_ITEMS_LIST
environment variable inget_env_vars()
function (default to False for backward compatibility)EnvVars.__init__()
to accepthide_items_list
parameterEnvVars.__repr__()
to includehide_items_list
write_to_markdown()
inmarkdown_writer.py
to conditionally skip writing the items table whenhide_items_list
is TrueREADME.md
to document the new environment variableTest Results
✅ All 135 tests pass (up from 133 - added 2 new tests)
✅ Code coverage: 91.42%
✅ Linting: 10.00/10 rating
✅ Manual testing verified correct behavior
✅ Prettier formatting applied to all markdown files
Behavior
Backward Compatibility
The default value is
false
, ensuring all existing workflows continue to work without any changes. Users must explicitly setHIDE_ITEMS_LIST=true
to hide the items list.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.