Skip to content

feat: add OUTPUT_FILENAME to customize markdown output#387

Open
vchrombie wants to merge 3 commits intogithub:mainfrom
vchrombie:feat/output-filename-env-18
Open

feat: add OUTPUT_FILENAME to customize markdown output#387
vchrombie wants to merge 3 commits intogithub:mainfrom
vchrombie:feat/output-filename-env-18

Conversation

@vchrombie
Copy link

@vchrombie vchrombie commented Jan 25, 2026

Fixes #18

Expose OUTPUT_FILENAME env var with default contributors.md, wire into markdown output, and document/test it.

Pull Request

Proposed Changes

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as either bug, documentation, enhancement, infrastructure, maintenance or breaking

Copilot AI review requested due to automatic review settings January 25, 2026 20:15
@vchrombie vchrombie requested a review from a team as a code owner January 25, 2026 20:15
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

Adds support for customizing the generated markdown report filename via a new OUTPUT_FILENAME environment variable (defaulting to contributors.md).

Changes:

  • Added OUTPUT_FILENAME parsing (with default) to env.get_env_vars().
  • Wired the configured output filename into contributors.py when writing the markdown report.
  • Updated tests and README to cover/document the new environment variable.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
env.py Adds OUTPUT_FILENAME env var handling and returns it from get_env_vars().
contributors.py Uses the returned output_filename when calling markdown.write_to_markdown().
test_env.py Extends env parsing tests to assert default and custom OUTPUT_FILENAME behavior.
README.md Documents OUTPUT_FILENAME and updates job summary wording to be filename-agnostic.

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

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

@vchrombie vchrombie force-pushed the feat/output-filename-env-18 branch from 30cb19a to d4ff051 Compare January 25, 2026 20:46
@zkoppert
Copy link
Member

zkoppert commented Feb 3, 2026

@vchrombie this looks great. I've got one documentation suggestion to help folks understand the default exists. Thanks for your PR!!

@vchrombie
Copy link
Author

Thanks @zkoppert for the suggestion.

Expose OUTPUT_FILENAME env var with default contributors.md,
wire into markdown output, and document/test it.

Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
Use a job-level OUTPUT_FILENAME and reference it in content-filepath
so examples stay in sync.

Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
@vchrombie vchrombie force-pushed the feat/output-filename-env-18 branch from d5a635a to cbb09ac Compare February 4, 2026 03:18
@vchrombie
Copy link
Author

vchrombie commented Feb 4, 2026

I rebased the branch with the latest changes

@zkoppert, could you please approve it to kick the ci checks?

Co-authored-by: Zack Koppert <zkoppert@github.com>
Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
@vchrombie vchrombie force-pushed the feat/output-filename-env-18 branch from c21a904 to b226a02 Compare February 4, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature: Add env variable to allow for setting custom output filename

2 participants