feat: add optional avatar column to contributors table#388
Open
vchrombie wants to merge 2 commits intogithub:mainfrom
Open
feat: add optional avatar column to contributors table#388vchrombie wants to merge 2 commits intogithub:mainfrom
vchrombie wants to merge 2 commits intogithub:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds an optional SHOW_AVATAR environment variable that allows users to display contributor profile pictures in the markdown output table. The feature addresses issue #23 by utilizing the avatar_url field that was already being stored.
Changes:
- Added
SHOW_AVATARenvironment variable with default value ofFalse - Added avatar column as the first column in the contributor table when enabled
- Added
_is_truthy()helper function to handle boolean conversion from string and bool types - Updated tests to cover the new avatar functionality and updated existing tests to handle the new parameter
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| env.py | Added SHOW_AVATAR environment variable handling via get_bool_env_var() and updated return type signature |
| contributors.py | Added show_avatar parameter to the flow, passing it from env to markdown output |
| markdown.py | Added _is_truthy() helper, added show_avatar parameter to functions, implemented avatar column with HTML img tags |
| test_env.py | Updated all test cases to include SHOW_AVATAR environment variable and verified it returns False when set to "False" |
| test_markdown.py | Added comprehensive test for avatar functionality with proper expected output validation |
| README.md | Documented the new SHOW_AVATAR configuration option with usage examples |
Add SHOW_AVATAR flag plumbing from env to markdown output so avatars render as a column when enabled, update README and tests accordingly. Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
vchrombie
force-pushed
the
feat/show-avatars-markdown-table-23
branch
from
b57096b to
8ec1034
Compare
Author
|
I believe there some lint errors in README.md, I fixed them. |
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
1 participant
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.
Fixes #23
Add SHOW_AVATAR flag plumbing from env to markdown output so avatars render as a column when enabled, update README and tests accordingly.
Pull Request
Proposed Changes
Readiness Checklist
Author/Contributor
make lintand fix any issues that you have introducedmake testand ensure you have test coverage for the lines you are introducing@jeffrey-luszczReviewer
bug,documentation,enhancement,infrastructure,maintenanceorbreaking