feat: allow archiving/unarchiving repositories (#481)

Based on available option in the REST API: https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository
github · May 23, 2023 · af044e9 · af044e9
1 parent 1938708
commit af044e9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -317,6 +317,9 @@ repository:
   # Default: `false`
   delete_branch_on_merge: true  
 
+  # Whether to archive this repository. false will unarchive a previously archived repository.
+  archived: false
+
 # The following attributes are applied to any repo within the org
 # So if a repo is not listed above is created or edited
 # The app will apply the following settings to it

diff --git a/lib/plugins/repository.js b/lib/plugins/repository.js
@@ -16,7 +16,6 @@ const ignorableFields = [
   'watchers_count',
   'language',
   'forks_count',
-  'archived',
   'disabled',
   'open_issues_count',
   'license',
@@ -273,7 +272,7 @@ module.exports = class Repository {
           resArray.push((new NopCommand(this.constructor.name, this.repo, null, `no need to update security for ${repoData.name}`)))
           return Promise.resolve(resArray)
         }
-      } 
+      }
   }
 
   updateAutomatedSecurityFixes(repoData, resArray) {