Release 0.1.0

CHANGELOG.md

@@ -6,9 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.0] - 2025-05-25
+### Added
+- #30 - Add parameter to terraform to set max number of runners (#31)
+
+### Updated
+- #17 - adding tests for syncer (#33)
+- #20 #21 - Improve docs, add readme, add hook generate terraform docs
+
 ## [0.0.1] - 2020-05-19
 ### Added
 - First release.
 
-[Unreleased]: https://github.com/philips-labs/terraform-aws-github-runner/compare/v0.0.1..HEAD
+[Unreleased]: https://github.com/philips-labs/terraform-aws-github-runner/compare/v0.1.0..HEAD
+[0.1.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.0.1..v0.1.0
 [0.0.1]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.0.1

README.md

@@ -88,20 +88,22 @@ Go to GitHub and create a new app. Beware you can create apps your organization
 First you need to download the lambda releases. The lambda code is available as a GitHub release asset. Downloading can be done with the provided terraform module for example. Note that this requires `curl` to be installed on your machine. Create an empty workspace with the following terraform code:
 
 ```terraform
-module "lambdas" {
-  source = "../../../modules/download-lambda"
+module "github-runner_download-lambda" {
+  source  = "philips-labs/github-runner/aws//modules/download-lambda"
+  version = "0.1.0"
+ 
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runners"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     }
   ]
 }
@@ -118,8 +120,9 @@ For local development you can build all the lambda's at once using `.ci/build.sh
 Next create a second terraform workspace and initiate the module, see the examples for more details.
 
 ```terraform
-module "runners" {
-  source = "git::https://github.com/philips-labs/terraform-aws-github-runner.git?ref=master"
+module "github-runner" {
+  source  = "philips-labs/github-runner/aws"
+  version = "0.1.0"
 
   aws_region = "eu-west-1"
   vpc_id     = "vpc-123"
@@ -146,7 +149,7 @@ module "runners" {
 
 ```bash
 terraform init
-terrafrom apply
+terraform apply
 ```
 
 Check the terraform output for the API gateway url (endpoint), which you need in the next step. The lambda for syncing the GitHub distribution will be executed by a trigger via CloudWatch. To ensure the binary is cached, trigger the `runner-binaries-syncer` manually. The payload does not matter. (e.g. `aws lambda invoke --function-name <environment>-syncer response.json`)

examples/default/lambdas-download/main.tf

@@ -3,15 +3,15 @@ module "lambdas" {
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runners"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     }
   ]
 }

examples/permissions-boundary/lambdas-download/main.tf

@@ -3,15 +3,15 @@ module "lambdas" {
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runners"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     }
   ]
 }

modules/download-lambda/README.md

@@ -10,15 +10,15 @@ module "lambdas" {
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runners"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.0.1"
+      tag  = "v0.1.0"
     }
   ]
 }
@@ -32,20 +32,20 @@ No requirements.
 ## Providers
 
 | Name | Version |
-|------|---------|
-| null | n/a |
+| ---- | ------- |
+| null | n/a     |
 
 ## Inputs
 
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| lambdas | Name and tag for lambdas to download. | <pre>list(object({<br>    name = string<br>    tag  = string<br>  }))</pre> | n/a | yes |
+| Name    | Description                           | Type                                                                        | Default | Required |
+| ------- | ------------------------------------- | --------------------------------------------------------------------------- | ------- | :------: |
+| lambdas | Name and tag for lambdas to download. | <pre>list(object({<br>    name = string<br>    tag  = string<br>  }))</pre> | n/a     |   yes    |
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
-| files | n/a |
+| Name  | Description |
+| ----- | ----------- |
+| files | n/a         |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->