diff --git a/LICENCE b/LICENSE similarity index 100% rename from LICENCE rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 0000000..8c7acd6 --- /dev/null +++ b/README.md @@ -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= +export CODEPIPELINE_GH_TOKEN= +``` + +## 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).