Skip to content

Add README and fix license file #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HarshCasper merged 2 commits into from
Mar 18, 2026
+25 −0
Merged

Add README and fix license file #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3c3449
Add README and fix license file
HarshCasper Mar 17, 2026
917aeb4
Enhance README with documentation link and cleanup
HarshCasper Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 LICENCE → LICENSE
View file
Open in desktop
File renamed without changes.
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# LocalStack CodePipeline Samples

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.

## Prerequisites

- 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.
- [Docker](https://docs.docker.com/get-docker/) with access to the Docker socket.
- [LocalStack CLI](https://docs.localstack.cloud/user-guide/tools/localstack-cli/) (`awslocal`) and AWS CLI.
- A GitHub Personal Access Token exported as `CODEPIPELINE_GH_TOKEN` (used by both samples to download source archives).
- `npm` (required for the CodeArtifact publishing sample).

```bash
export LOCALSTACK_AUTH_TOKEN=<your-auth-token>
export CODEPIPELINE_GH_TOKEN=<your-github-pat>
```

## Samples

- [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.
- [2-codebuild-test-codeartifact-publish](2-codebuild-test-codeartifact-publish/README.md): Tests a `lodash` fork and publishes the package to CodeArtifact through CodePipeline.

## License

Licensed under the Apache License 2.0. See [LICENSE](LICENSE).