feat: Status column #553
Merged
feat: Status column #553
Conversation
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
Signed-off-by: Zack Koppert <zkoppert@github.com>
Signed-off-by: Zack Koppert <zkoppert@github.com>
Signed-off-by: Zack Koppert <zkoppert@github.com>
Signed-off-by: Zack Koppert <zkoppert@github.com>
zkoppert
commented
Jul 18, 2025
| @@ -154,7 +154,8 @@ This action can be configured to authenticate with GitHub App Installation or Pe | |||
| | `HIDE_TIME_TO_ANSWER` | False | False | If set to `true`, the time to answer a discussion will not be displayed in the generated Markdown file. | | |||
| | `HIDE_TIME_TO_CLOSE` | False | False | If set to `true`, the time to close will not be displayed in the generated Markdown file. | | |||
| | `HIDE_TIME_TO_FIRST_RESPONSE` | False | False | If set to `true`, the time to first response will not be displayed in the generated Markdown file. | | |||
| | `HIDE_CREATED_AT` | False | True | If set to `true`, the creation timestmap will not be displayed in the generated Markdown file. | | |||
| | `HIDE_STATUS` | False | True | If set to `true`, the status column will not be shown | | |||
| | `HIDE_CREATED_AT` | False | True | If set to `true`, the creation timestamp will not be displayed in the generated Markdown file. | | |||
There was a problem hiding this comment.
HIDE_CREATED_AT is not related to this change. I just noticed it wasn't properly documented.
zkoppert
commented
Jul 18, 2025
| @@ -39,6 +39,8 @@ class EnvVars: | |||
| hide_time_to_close (bool): If true, the time to close metric is hidden in the output | |||
| hide_time_to_first_response (bool): If true, the time to first response metric is hidden | |||
| in the output | |||
| hide_created_at (bool): If true, the created at timestamp is hidden in the output | |||
There was a problem hiding this comment.
hide_created_at is not related to this change. I just noticed it wasn't properly documented.
zkoppert
commented
Jul 18, 2025
| elif issue.state == "open": # type: ignore | ||
| num_issues_open += 1 | ||
| if env_vars.hide_status is False: | ||
| issue_with_metrics.status = f"{issue.issue.state}" # type: ignore |
There was a problem hiding this comment.
open issues don't have a state_reason
Signed-off-by: Zack Koppert <zkoppert@github.com>
jmeridth
approved these changes
Jul 18, 2025
Co-authored-by: Jason Meridth <35014+jmeridth@users.noreply.github.com> Signed-off-by: Zack Koppert <zkoppert@github.com>
Co-authored-by: Jason Meridth <35014+jmeridth@users.noreply.github.com> Signed-off-by: Zack Koppert <zkoppert@github.com>
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.
Pull Request
This pull request introduces a new "Status" column to the issue metrics system and makes it configurable through an environment variable (
HIDE_STATUS). It also updates the relevant classes, docs, functions, and tests to support this feature.Here is an example report with HIDE_STATUS set to false:
fixes #552
Proposed Changes
New Feature: Status Column
statusattribute to theIssueWithMetricsclass to store issue statuses (e.g., "open", "closed as completed") (classes.py, [1] [2] [3].get_per_issue_metricsfunction to populate thestatusfield based on the issue's state and state reason (issue_metrics.py, issue_metrics.pyR178-R183).Configuration Updates
HIDE_STATUSto control the visibility of the "Status" column in the output (config.py, [1] [2] [3] [4] [5] [6].HIDE_STATUSenvironment variable (README.md, README.mdL157-R158).Markdown Generation Enhancements
get_non_hidden_columnsfunction and Markdown-writing logic to include the "Status" column when not hidden (markdown_writer.py, [1] [2] [3].Test Coverage
HIDE_STATUSenvironment variable and the inclusion of the "Status" column in the output (test_config.py, [1] [2] [3] [4];test_markdown_writer.py, [5] [6] [7] [8];test_assignee_functionality.py, [9].These changes enhance the flexibility and usability of the issue metrics system by allowing users to track and customize the visibility of issue statuses.
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
fix,documentation,enhancement,infrastructure,maintenance, orbreaking