Merge pull request #1113 from philips-labs/develop

Release

Author: npalm

.github/workflows/lambda-runner-binaries-syncer.yml

@@ -22,6 +22,8 @@ jobs:
       - uses: actions/checkout@v2
       - name: Install dependencies
         run: yarn install
+      - name: Run prettier
+        run: yarn format-check
       - name: Run linter
         run: yarn lint
       - name: Run tests

.github/workflows/lambda-runners.yml

@@ -20,6 +20,8 @@ jobs:
       - uses: actions/checkout@v2
       - name: Install dependencies
         run: yarn install
+      - name: Run prettier
+        run: yarn format-check
       - name: Run linter
         run: yarn lint
       - name: Run tests

.github/workflows/lambda-webhook.yml

@@ -20,6 +20,8 @@ jobs:
       - uses: actions/checkout@v2
       - name: Install dependencies
         run: yarn install
+      - name: Run prettier
+        run: yarn format-check
       - name: Run linter
         run: yarn lint
       - name: Run tests

.release/yarn.lock

@@ -3387,9 +3387,9 @@ path-key@^3.0.0, path-key@^3.1.0:
   integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==
 
 path-parse@^1.0.6:
-  version "1.0.6"
-  resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.6.tgz#d62dbb5679405d72c4737ec58600e9ddcf06d24c"
-  integrity sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==
+  version "1.0.7"
+  resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735"
+  integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==
 
 path-type@^2.0.0:
   version "2.0.0"

CONTRIBUTING.md

@@ -2,11 +2,11 @@
 
 We'd love for you to contribute to our source code and to make the Forest even better than it is today! Here are the guidelines we'd like you to follow:
 
- - [Question or Problem?](#question)
- - [Issues and Bugs](#issue)
- - [Feature Requests](#feature)
- - [Submission Guidelines](#submit)
- - [Further Info](#info)
+* [Question or Problem?](#question)
+* [Issues and Bugs](#issue)
+* [Feature Requests](#feature)
+* [Submission Guidelines](#submit)
+* [Further Info](#info)
 
 ## <a name="question"></a> Got a Question or Problem?
 
@@ -27,7 +27,6 @@ You can request a new feature by submitting an issue to our [Github Repository][
 * **Major Changes** that you wish to contribute to the project should be discussed first on our [Slack group][slack] so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
 * **Small Changes** can be crafted and submitted to the [Github Repository][github] as a Pull Request.
 
-
 ## <a name="docs"></a> Want a Doc Fix?
 
 If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Create a new issue (or comment on a related existing one) to let others know what you're working on.
@@ -37,6 +36,7 @@ For large fixes, please build and test the documentation before submitting the M
 ## <a name="submit"></a> Submission Guidelines
 
 ### Submitting an Issue
+
 Before you submit your issue search the archive, maybe your question was already answered.
 
 If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
@@ -58,18 +58,18 @@ Before you submit your merge request consider the following guidelines:
 * Make your changes in a new git branch:
 
     ```shell
-    git checkout -b my-fix-branch master
+    git checkout -b my-fix-branch develop
     ```
 
 * Create your patch, **including appropriate test cases**.
 * Run the test suite and ensure that all tests pass.
-* Add a line in the CHANGELOG.md under Unreleased. This will be used form generating the release notes.
 * Install [pre-commit hooks](https://pre-commit.com/). The hooks runs some basic checks and update the docs. The commit will run the hooks, you can invoke the hooks manually `pre-commit run --all-files` as well.
 * Commit your changes using a descriptive commit message.
 
     ```shell
     git commit -a
     ```
+
   Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
 
 * Build your changes locally to ensure all the tests pass:
@@ -79,7 +79,7 @@ Before you submit your merge request consider the following guidelines:
     git push origin my-fix-branch
     ```
 
-In Github, send a pull request to original master branch: f.e. `terraform-aws-vpc:master`.
+In Github, send a pull request to original develop branch: f.e. `terraform-aws-vpc:develop`.
 If we suggest changes, then:
 
 * Make the required updates.
@@ -89,10 +89,10 @@ If we suggest changes, then:
 
 If the PR gets too outdated we may ask you to rebase and force push to update the PR:
 
-```shell
-git rebase master -i
-git push origin my-fix-branch -f
-```
+    ```shell
+    git rebase develop -i
+    git push origin my-fix-branch -f
+    ```
 
 _WARNING: Squashing or reverting commits and force-pushing thereafter may remove Github comments on code that were previously made by you or others in your commits. Avoid any form of rebasing unless necessary._
 
@@ -109,10 +109,10 @@ from the main (upstream) repository:
     git push origin --delete my-fix-branch
     ```
 
-* Check out the master branch:
+* Check out the develop branch:
 
     ```shell
-    git checkout master -f
+    git checkout develop -f
     ```
 
 * Delete the local branch:
@@ -121,10 +121,10 @@ from the main (upstream) repository:
     git branch -D my-fix-branch
     ```
 
-* Update your master with the latest upstream version:
+* Update your develop with the latest upstream version:
 
     ```shell
-    git pull --ff upstream master
+    git pull --ff upstream develop
     ```
 
 ## <a name="info"></a> Info
@@ -136,5 +136,5 @@ Use the badge to sign-up.
 [![Slack](https://philips-software-slackin.now.sh/badge.svg)](https://philips-software-slackin.now.sh)
 
 [contribute]: CONTRIBUTING.md
-[github]: https://github.com/philips-lam/terraform-aws-github-runner/issues 
+[github]: https://github.com/philips-labs/terraform-aws-github-runner/issues
 [slack]: https://philips-software.slack.com/home

README.md

@@ -233,7 +233,7 @@ You are now ready to run action workloads on self hosted runner. Remember that b
 
 ### Encryption
 
-The module support 3 scenario's to manage environment secrets and private key of the Lambda functions.
+The module support 2 scenarios to manage environment secrets and private key of the Lambda functions.
 
 #### Encrypted via a module managed KMS key (default) <!-- omit in toc -->
 
@@ -257,10 +257,6 @@ module "runners" {
 
 ```
 
-#### No encryption <!-- omit in toc -->
-
-Not advised but you can disable the encryption as by setting the variable `encrypt_secrets` to `false`.
-
 ### Idle runners
 
 The module will scale down to zero runners be default, by specifying a `idle_config` config idle runners can be kept active. The scale down lambda checks if any of the cron expressions matches the current time with a marge of 5 seconds. When there is a match the number of runners specified in the idle config will be kept active. In case multiple cron expressions matches only the first one is taken in to account. Below an idle configuration for keeping runners active from 9 to 5 on working days.

examples/default/README.md

@@ -1,10 +1,10 @@
 # Action runners deployment default example
 
-This modules shows how to create GitHub action runners. Lambda release will be downloaded from GitHub.
+This module shows how to create GitHub action runners. Lambda release will be downloaded from GitHub.
 
 ## Usages
 
-Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md). First download the Lambda releases from GitHub. Alternatively you can build the lambdas locally with Node or Docker, there is a simple build script in `<root>/.ci/build.sh`. In the `main.tf` you can simple remove the location of the lambda zip files, the default location will work in this case.
+Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md). First download the Lambda releases from GitHub. Alternatively you can build the lambdas locally with Node or Docker, there is a simple build script in `<root>/.ci/build.sh`. In the `main.tf` you can simply remove the location of the lambda zip files, the default location will work in this case.
 
 > Ensure you have set the version in `lambdas-download/main.tf` for running the example. The version needs to be set to a GitHub release version, see https://github.com/philips-labs/terraform-aws-github-runner/releases
 

examples/permissions-boundary/README.md

@@ -1,10 +1,10 @@
 # Action runners deployed with permissions boundary
 
-This modules shows how to create GitHub action runners with permissions boundaries and paths used in role, policies, and instance profiles.
+This module shows how to create GitHub action runners with permissions boundaries and paths used in role, policies, and instance profiles.
 
 ## Usages
 
-Steps for the full setup, such as creating a GitHub app can be find the module [README](../../README.md). First create the deploy role and boundary policies. This steps required an admin user.
+Steps for the full setup, such as creating a GitHub app can be find the module [README](../../README.md). First create the deploy role and boundary policies. These steps require an admin user.
 
 > Ensure you have set the version in `lambdas-download/main.tf` for running the example. The version needs to be set to a GitHub release version, see https://github.com/philips-labs/terraform-aws-github-runner/releases
 

examples/permissions-boundary/setup/outpus.tf renamed to examples/permissions-boundary/setup/outputs.tf

@@ -1,10 +1,10 @@
 # Action runners deployment ubuntu example
 
-This modules shows how to create GitHub action runners using an Ubuntu AMI. Lambda release will be downloaded from GitHub.
+This module shows how to create GitHub action runners using an Ubuntu AMI. Lambda release will be downloaded from GitHub.
 
 ## Usages
 
-Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md). First download the Lambda releases from GitHub. Alternatively you can build the lambdas locally with Node or Docker, there is a simple build script in `<root>/.ci/build.sh`. In the `main.tf` you can simple remove the location of the lambda zip files, the default location will work in this case.
+Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md). First download the Lambda releases from GitHub. Alternatively you can build the lambdas locally with Node or Docker, there is a simple build script in `<root>/.ci/build.sh`. In the `main.tf` you can simply remove the location of the lambda zip files, the default location will work in this case.
 
 > Ensure you have set the version in `lambdas-download/main.tf` for running the example. The version needs to be set to a GitHub release version, see https://github.com/philips-labs/terraform-aws-github-runner/releases