This pull request adds a feature to support specifying a team in addition to an organization. This enables users to run the action on all the repositories owned by a team instead of having to keep that list up to date with the team ownership data already in GitHub. The most important changes include updating the README.md to reflect the new TEAM_NAME parameter, modifying the env.py and evergreen.py files to handle the new parameter, and adding tests in test_env.py to ensure the new functionality works as expected.
Proposed Changes
Documentation Updates:
README.md: Added TEAM_NAME parameter to describe how to configure the action for a specific team within an organization. [1][2][3]
Code Enhancements:
env.py: Updated get_env_vars function to include team_name parameter and added validation to ensure TEAM_NAME is not used with ORGANIZATION or REPOSITORY. [1][2][3][4]
evergreen.py: Modified the main function and get_repos_iterator to handle repositories based on the TEAM_NAME parameter. [1][2][3][4]
Testing:
test_env.py: Added new tests to verify the correct behavior when TEAM_NAME is set and to ensure errors are raised when TEAM_NAME is used without ORGANIZATION or with REPOSITORY. [1][2][3][4][5][6]
Readiness Checklist
Author/Contributor
[x] If documentation is needed for this change, has that been included in this pull request
[x] run make lint and fix any issues that you have introduced
[x] run make test and ensure you have test coverage for the lines you are introducing
[x] If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz
Reviewer
[x] Label as either fix, documentation, enhancement, infrastructure, maintenance or breaking
Pull Request
fixes #74
This pull request adds a feature to support specifying a team in addition to an organization. This enables users to run the action on all the repositories owned by a team instead of having to keep that list up to date with the team ownership data already in GitHub. The most important changes include updating the
README.mdto reflect the newTEAM_NAMEparameter, modifying theenv.pyandevergreen.pyfiles to handle the new parameter, and adding tests intest_env.pyto ensure the new functionality works as expected.Proposed Changes
Documentation Updates:
README.md: AddedTEAM_NAMEparameter to describe how to configure the action for a specific team within an organization. [1] [2] [3]Code Enhancements:
env.py: Updatedget_env_varsfunction to includeteam_nameparameter and added validation to ensureTEAM_NAMEis not used withORGANIZATIONorREPOSITORY. [1] [2] [3] [4]evergreen.py: Modified the main function andget_repos_iteratorto handle repositories based on theTEAM_NAMEparameter. [1] [2] [3] [4]Testing:
test_env.py: Added new tests to verify the correct behavior whenTEAM_NAMEis set and to ensure errors are raised whenTEAM_NAMEis used withoutORGANIZATIONor withREPOSITORY. [1] [2] [3] [4] [5] [6]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,maintenanceorbreaking