Merge branch 'main' into copilot/fix-377

Author: zkoppert

.github/copilot-instructions.md

@@ -0,0 +1,30 @@
+# Copilot Instructions
+
+This is a GitHub Action that given an organization, team, or specified repositories, opens an issue/PR if dependabot is not enabled, or there are more package ecosystems that could be added. It also enables [automated security updates](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#managing-dependabot-security-updates-for-your-repositories) for the repository. Please follow these guidelines when contributing:
+
+## Code Standards
+
+### Required Before Each Commit
+
+- Run `make lint` before committing any changes to ensure proper code linting and formatting.
+
+### Development Flow
+
+- Lint: `make lint`
+- Test: `make test`
+
+## Repository Structure
+
+- `Makefile`: Contains commands for linting, testing, and other tasks
+- `requirements.txt`: Python dependencies for the project
+- `requirements-test.txt`: Python dependencies for testing
+- `README.md`: Project documentation and setup instructions
+- `setup.py`: Python package setup configuration
+- `test_*.py`: Python test files matching the naming convention for test discovery
+
+## Key Guidelines
+
+1. Follow Python best practices and idiomatic patterns
+2. Maintain existing code structure and organization
+3. Write unit tests for new functionality.
+4. Document changes to environment variables in the `README.md` file.

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,38 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+# Set the permissions to the lowest permissions possible needed for your steps.
+# Copilot will be given its own token for its operations.
+permissions:
+  # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+  contents: read
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - name: Checkout code
+        uses: actions/[email protected]
+
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: 3.12
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt -r requirements-test.txt

.github/workflows/super-linter.yaml

@@ -35,3 +35,4 @@ jobs:
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GITHUB_ACTIONS_COMMAND_ARGS: -shellcheck=
+          FIX_MARKDOWN_PRETTIER: true

README.md

@@ -99,6 +99,7 @@ def get_env_vars(
 ) -> tuple[
     str | None,
     list[str],
+    str | None,
     int | None,
     int | None,
     bytes,
@@ -135,6 +136,7 @@ def get_env_vars(
     Returns:
         organization (str): The organization to search for repositories in
         repository_list (list[str]): A list of repositories to search for
+        search_query (str): A search query string to filter repositories by
         gh_app_id (int | None): The GitHub App ID to use for authentication
         gh_app_installation_id (int | None): The GitHub App Installation ID to use for authentication
         gh_app_private_key_bytes (bytes): The GitHub App Private Key as bytes to use for authentication
@@ -162,18 +164,19 @@ def get_env_vars(
         dependabot_config_file (str): Dependabot extra configuration file location path
     """
 
-    if not test:
+    if not test:  # pragma: no cover
         # Load from .env file if it exists and not testing
         dotenv_path = join(dirname(__file__), ".env")
         load_dotenv(dotenv_path)
 
     organization = os.getenv("ORGANIZATION")
     repositories_str = os.getenv("REPOSITORY")
+    search_query = os.getenv("REPOSITORY_SEARCH_QUERY", "").strip()
     team_name = os.getenv("TEAM_NAME")
-    # Either organization or repository must be set
-    if not organization and not repositories_str:
+    # Either organization, repository, or search_query must be set
+    if not organization and not repositories_str and not search_query:
         raise ValueError(
-            "ORGANIZATION and REPOSITORY environment variables were not set. Please set one"
+            "ORGANIZATION, REPOSITORY, and REPOSITORY_SEARCH_QUERY environment variables were not set. Please set one"
         )
     # Team name and repository are mutually exclusive
     if repositories_str and team_name:
@@ -352,6 +355,7 @@ def get_env_vars(
     return (
         organization,
         repositories_list,
+        search_query,
         gh_app_id,
         gh_app_installation_id,
         gh_app_private_key_bytes,

env.py

@@ -20,6 +20,7 @@ def main():  # pragma: no cover
     (
         organization,
         repository_list,
+        search_query,
         gh_app_id,
         gh_app_installation_id,
         gh_app_private_key,
@@ -77,7 +78,7 @@ def main():  # pragma: no cover
 
     # Get the repositories from the organization, team name, or list of repositories
     repos = get_repos_iterator(
-        organization, team_name, repository_list, github_connection
+        organization, team_name, repository_list, search_query, github_connection
     )
 
     # Setting up the action summary content
@@ -341,9 +342,21 @@ def enable_dependabot_security_updates(ghe, owner, repo, access_token):
         print("\tFailed to enable Dependabot security updates.")
 
 
-def get_repos_iterator(organization, team_name, repository_list, github_connection):
-    """Get the repositories from the organization, team_name, or list of repositories"""
+def get_repos_iterator(
+    organization, team_name, repository_list, search_query, github_connection
+):
+    """Get the repositories from the organization, team_name, repository_list, or via search query"""
+    # Use GitHub search API if REPOSITORY_SEARCH_QUERY is set
+    if search_query:
+        # Return repositories matching the search query
+        repos = []
+        # Search results need to be converted to a list of repositories since they are returned as a search iterator
+        for repo in github_connection.search_repositories(search_query):
+            repos.append(repo.repository)
+        return repos
+
     repos = []
+    # Default behavior: list all organization/team repositories or specific repository list
     if organization and not repository_list and not team_name:
         repos = github_connection.organization(organization).repositories()
     elif team_name and organization:

evergreen.py

@@ -39,6 +39,7 @@ def setUp(self):
             "TYPE",
             "UPDATE_EXISTING",
             "REPO_SPECIFIC_EXEMPTIONS",
+            "REPOSITORY_SEARCH_QUERY",
             "SCHEDULE",
             "SCHEDULE_DAY",
             "LABELS",
@@ -68,6 +69,7 @@ def test_get_env_vars_with_org(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -120,6 +122,7 @@ def test_get_env_vars_with_org_and_repo_specific_exemptions(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -232,6 +235,7 @@ def test_get_env_vars_with_repos(self):
         expected_result = (
             None,
             ["org/repo1", "org2/repo2"],
+            "",  # search_query
             None,
             None,
             b"",
@@ -289,6 +293,7 @@ def test_get_env_vars_with_team(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -364,6 +369,7 @@ def test_get_env_vars_optional_values(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -410,6 +416,7 @@ def test_get_env_vars_with_update_existing(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -450,7 +457,7 @@ def test_get_env_vars_missing_org_or_repo(self):
         the_exception = cm.exception
         self.assertEqual(
             str(the_exception),
-            "ORGANIZATION and REPOSITORY environment variables were not set. Please set one",
+            "ORGANIZATION, REPOSITORY, and REPOSITORY_SEARCH_QUERY environment variables were not set. Please set one",
         )
 
     @patch.dict(
@@ -470,6 +477,7 @@ def test_get_env_vars_auth_with_github_app_installation(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             12345,
             678910,
             b"hello",
@@ -559,6 +567,7 @@ def test_get_env_vars_with_repos_no_dry_run(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -605,6 +614,7 @@ def test_get_env_vars_with_repos_disabled_security_updates(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -652,6 +662,7 @@ def test_get_env_vars_with_repos_filter_visibility_multiple_values(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -699,6 +710,7 @@ def test_get_env_vars_with_repos_filter_visibility_single_value(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -776,6 +788,7 @@ def test_get_env_vars_with_repos_filter_visibility_no_duplicates(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -824,6 +837,7 @@ def test_get_env_vars_with_repos_exempt_ecosystems(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -871,6 +885,7 @@ def test_get_env_vars_with_no_batch_size(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -919,6 +934,7 @@ def test_get_env_vars_with_batch_size(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -1056,6 +1072,7 @@ def test_get_env_vars_with_valid_schedule_and_schedule_day(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -1141,6 +1158,7 @@ def test_get_env_vars_with_a_valid_label(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",
@@ -1187,6 +1205,7 @@ def test_get_env_vars_with_valid_labels_containing_spaces(self):
         expected_result = (
             "my_organization",
             [],
+            "",  # search_query
             None,
             None,
             b"",