From 06fab3c38ab00a3ffed6f0c3bbad258e7f0e2d9c Mon Sep 17 00:00:00 2001
From: Stephen Boyd <stephen.boyd@sohonet.com>
Date: Mon, 20 May 2024 14:41:26 -0700
Subject: [PATCH] githuborg: Support ignoring archived repositories in an
 organization

Change-Id: Icb3591882e29a92819794e9bdcdc2c2f9f617016
---
 jenkins_jobs/modules/project_githuborg.py     | 8 ++++++++
 tests/githuborg/fixtures/github-org-full.xml  | 1 +
 tests/githuborg/fixtures/github-org-full.yaml | 1 +
 3 files changed, 10 insertions(+)

diff --git a/jenkins_jobs/modules/project_githuborg.py b/jenkins_jobs/modules/project_githuborg.py
index 1ef6fbdae..e6ab7f9a2 100644
--- a/jenkins_jobs/modules/project_githuborg.py
+++ b/jenkins_jobs/modules/project_githuborg.py
@@ -248,6 +248,8 @@ def github_org(xml_parent, data):
         (like to disable SCM triggering or to override the pipeline durability)
         (optional)
         Refer to :func:`~property_strategies <project_multibranch.property_strategies>`.
+    :arg bool exclude-archived-repositories: Whether archived repositories are
+        excluded when scanning an organization. (default: false) (optional)
     :arg bool ssh-checkout: Checkout over SSH.
 
         * **credentials** ('str'): Credentials to use for
@@ -452,3 +454,9 @@ def github_org(xml_parent, data):
             "".join([disable_github_status_path_dscore, ".DisableStatusUpdateTrait"]),
             {"plugin": "disable-github-multibranch-status"},
         )
+
+    if data.get("exclude-archived-repositories", False):
+        XML.SubElement(
+            traits,
+            "".join([github_path_dscore, ".ExcludeArchivedRepositoriesTrait"]),
+        )
diff --git a/tests/githuborg/fixtures/github-org-full.xml b/tests/githuborg/fixtures/github-org-full.xml
index 90c8f5173..4c46cc1b3 100644
--- a/tests/githuborg/fixtures/github-org-full.xml
+++ b/tests/githuborg/fixtures/github-org-full.xml
@@ -139,6 +139,7 @@
           </templates>
         </jenkins.plugins.git.traits.RefSpecsSCMSourceTrait>
         <com.adobe.jenkins.disable__github__multibranch__status.DisableStatusUpdateTrait plugin="disable-github-multibranch-status"/>
+        <org.jenkinsci.plugins.github__branch__source.ExcludeArchivedRepositoriesTrait/>
       </traits>
       <strategy class="jenkins.branch.DefaultBranchPropertyStrategy">
         <properties class="java.util.Arrays$ArrayList">
diff --git a/tests/githuborg/fixtures/github-org-full.yaml b/tests/githuborg/fixtures/github-org-full.yaml
index 3525e6301..2494c58ef 100644
--- a/tests/githuborg/fixtures/github-org-full.yaml
+++ b/tests/githuborg/fixtures/github-org-full.yaml
@@ -30,6 +30,7 @@ github-org:
         discover-pr-forks-trust: everyone
         discover-pr-origin: both
         discover-tags: true
+        exclude-archived-repositories: true
         notification-context:
             label: 'jenkins.example.com/my_context'
             suffix: false