@@ -5,41 +5,41 @@ A Python utility used to archive old, unused GitHub repositories from an organis
55## Table of Contents
66
77- [ GitHub Repository Archive Script] ( #github-repository-archive-script )
8- - [ Table of Contents] ( #table-of-contents )
9- - [ Prerequisites] ( #prerequisites )
10- - [ Makefile] ( #makefile )
11- - [ Documentation] ( #documentation )
12- - [ Development] ( #development )
13- - [ Running the Project] ( #running-the-project )
14- - [ Containerised (Recommended)] ( #containerised-recommended )
15- - [ Outside of a Container (Development only)] ( #outside-of-a-container-development-only )
16- - [ Deployment] ( #deployment )
17- - [ Deployments with Concourse] ( #deployments-with-concourse )
18- - [ Allowlisting your IP] ( #allowlisting-your-ip )
19- - [ Setting up a pipeline] ( #setting-up-a-pipeline )
20- - [ Prod deployment] ( #prod-deployment )
21- - [ Triggering a pipeline] ( #triggering-a-pipeline )
22- - [ Destroying a pipeline] ( #destroying-a-pipeline )
23- - [ Manual Deployment] ( #manual-deployment )
24- - [ Overview] ( #overview )
25- - [ Deployment Prerequisites] ( #deployment-prerequisites )
26- - [ Storing the Container on AWS Elastic Container Registry (ECR)] ( #storing-the-container-on-aws-elastic-container-registry-ecr )
27- - [ Deploying the Lambda] ( #deploying-the-lambda )
28- - [ Destroying / Removing the Lambda] ( #destroying--removing-the-lambda )
29- - [ Linting and Testing] ( #linting-and-testing )
30- - [ GitHub Actions] ( #github-actions )
31- - [ Running Tests Locally] ( #running-tests-locally )
8+ - [ Table of Contents] ( #table-of-contents )
9+ - [ Prerequisites] ( #prerequisites )
10+ - [ Makefile] ( #makefile )
11+ - [ Documentation] ( #documentation )
12+ - [ Development] ( #development )
13+ - [ Running the Project] ( #running-the-project )
14+ - [ Containerised (Recommended)] ( #containerised-recommended )
15+ - [ Outside of a Container (Development only)] ( #outside-of-a-container-development-only )
16+ - [ Deployment] ( #deployment )
17+ - [ Deployments with Concourse] ( #deployments-with-concourse )
18+ - [ Allowlisting your IP] ( #allowlisting-your-ip )
19+ - [ Setting up a pipeline] ( #setting-up-a-pipeline )
20+ - [ Prod deployment] ( #prod-deployment )
21+ - [ Triggering a pipeline] ( #triggering-a-pipeline )
22+ - [ Destroying a pipeline] ( #destroying-a-pipeline )
23+ - [ Manual Deployment] ( #manual-deployment )
24+ - [ Overview] ( #overview )
25+ - [ Deployment Prerequisites] ( #deployment-prerequisites )
26+ - [ Storing the Container on AWS Elastic Container Registry (ECR)] ( #storing-the-container-on-aws-elastic-container-registry-ecr )
27+ - [ Deploying the Lambda] ( #deploying-the-lambda )
28+ - [ Destroying / Removing the Lambda] ( #destroying--removing-the-lambda )
29+ - [ Linting and Testing] ( #linting-and-testing )
30+ - [ GitHub Actions] ( #github-actions )
31+ - [ Running Tests Locally] ( #running-tests-locally )
3232
3333## Prerequisites
3434
3535- A Docker Daemon (Colima is recommended)
36- - [ Colima] ( https://github.com/abiosoft/colima )
36+ - [ Colima] ( https://github.com/abiosoft/colima )
3737- Terraform (For deployment)
38- - [ Terraform] ( https://www.terraform.io/ )
38+ - [ Terraform] ( https://www.terraform.io/ )
3939- Python >3.12
40- - [ Python] ( https://www.python.org/ )
40+ - [ Python] ( https://www.python.org/ )
4141- Make
42- - [ GNU make] ( https://www.gnu.org/software/make/manual/make.html#Overview )
42+ - [ GNU make] ( https://www.gnu.org/software/make/manual/make.html#Overview )
4343
4444## Makefile
4545
@@ -146,7 +146,7 @@ Before the doing the following, make sure your Daemon is running. If using Colim
146146 When running the container, you are required to pass some environment variables:
147147
148148 | Variable | Description |
149- | --------------------------- | -------------------------------------------------------------------------------------------------- |
149+ | ----------------------------- | ---------------------------------------------------------------------------------------------------- |
150150 | GITHUB_ORG | The organisation you would like to run the tool in. |
151151 | GITHUB_APP_CLIENT_ID | The Client ID for the GitHub App which the tool uses to authenticate with the GitHub API. |
152152 | AWS_DEFAULT_REGION | The AWS Region which the Secret Manager Secret is in. |
0 commit comments