Skip to content

Commit 1dc6cf6

Browse files
authored
Add README and fix license file
Add README and fix license file
1 parent 2c2dadd commit 1dc6cf6

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

File renamed without changes.

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# LocalStack CodePipeline Samples
2+
3+
This repository contains two sample applications that demonstrate [LocalStack's CodePipeline emulation](https://docs.localstack.cloud/aws/services/codepipeline) with CodeBuild, S3, and CodeArtifact workflows.
4+
5+
## Prerequisites
6+
7+
- A valid [LocalStack for AWS license](https://localstack.cloud/pricing), which provides a [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/) required to run these samples.
8+
- [Docker](https://docs.docker.com/get-docker/) with access to the Docker socket.
9+
- [LocalStack CLI](https://docs.localstack.cloud/user-guide/tools/localstack-cli/) (`awslocal`) and AWS CLI.
10+
- A GitHub Personal Access Token exported as `CODEPIPELINE_GH_TOKEN` (used by both samples to download source archives).
11+
- `npm` (required for the CodeArtifact publishing sample).
12+
13+
```bash
14+
export LOCALSTACK_AUTH_TOKEN=<your-auth-token>
15+
export CODEPIPELINE_GH_TOKEN=<your-github-pat>
16+
```
17+
18+
## Samples
19+
20+
- [1-codebuild-compile-s3-upload](1-codebuild-compile-s3-upload/README.md): Builds `fzf` with CodeBuild and uploads the resulting binary to S3 through CodePipeline.
21+
- [2-codebuild-test-codeartifact-publish](2-codebuild-test-codeartifact-publish/README.md): Tests a `lodash` fork and publishes the package to CodeArtifact through CodePipeline.
22+
23+
## License
24+
25+
Licensed under the Apache License 2.0. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)