Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yang0352 committed Apr 9, 2025
1 parent 2cc9413 commit 761cf5d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ This repository hosts `eks-automation-lambda` automation work at `Census`.
- requirements.txt
- pre-commit hook

## Install `virtualenv`
## Project Setup

### Install `virtualenv`

```sh
pip install virtualenv
Expand Down Expand Up @@ -62,3 +64,9 @@ reformatted main.py
All done! ✨ 🍰 ✨
1 files reformatted, 1 files left unchanged.
```

## NOTES

- This lambda function relies on [`git-lambda-layer`](https://github.com/lambci/git-lambda-layer), which must be uploaded to the S3 bucket specified in samconfig.toml prior to deployment.
- The REST API for this Lambda function is configured to be accessed using an API key.
- To access the Census GitHub Enterprise Server, a VPC with private subnets connected to the server must be attached.

0 comments on commit 761cf5d

Please sign in to comment.