Skip to content

Commit 98ac3f3

Browse files
committed
update readme with quickstart
1 parent fa5cd54 commit 98ac3f3

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,23 @@ This function should be deployed using the
6969
[terraform-aws-github-action-token-rotator](https://github.com/cloudposse/terraform-aws-github-action-token-rotator.git)
7070
module.
7171

72+
## Quick Start
7273

74+
1. Browse to https://github.com/organizations/{YOUR_ORG}/settings/apps and click the New GitHub App button
75+
1. Set the name to "GitHub Action Token Rotator"
76+
1. Set the Homepage URL to `https://github.com/cloudposse/lambda-github-action-token-rotator`
77+
1. Uncheck the Active checkbox under the Webhook heading
78+
1. Select `Read and write` under Organization permissions -> Self-hosted runners
79+
1. Click the Create GitHub App button at the bottom of the page
80+
81+
1. Under the `Client secrets` section, click the `Generate a new client secret` button
82+
1. Copy the Client secret to a safe place, it will be needed to install the app
83+
84+
1. Under the `Private key` section, click the `Generate a private key` button
85+
1. Download the private key to a safe place, it will be needed to install the app
86+
87+
1. Convert the private key to a PEM file using the following command:
88+
`openssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt -in {DOWNLOADED_FILE_NAME}.pem -out private-key-pkcs8.key`
7389

7490

7591

README.yaml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,22 @@ usage: |-
7575
# TODO: Add examples
7676

7777
# How to get started quickly
78-
#quickstart: |-
79-
# Here's how to get started...
80-
# TODO: update this section
78+
quickstart: |-
79+
1. Browse to https://github.com/organizations/{YOUR_ORG}/settings/apps and click the New GitHub App button
80+
1. Set the name to "GitHub Action Token Rotator"
81+
1. Set the Homepage URL to `https://github.com/cloudposse/lambda-github-action-token-rotator`
82+
1. Uncheck the Active checkbox under the Webhook heading
83+
1. Select `Read and write` under Organization permissions -> Self-hosted runners
84+
1. Click the Create GitHub App button at the bottom of the page
85+
86+
1. Under the `Client secrets` section, click the `Generate a new client secret` button
87+
1. Copy the Client secret to a safe place, it will be needed to install the app
88+
89+
1. Under the `Private key` section, click the `Generate a private key` button
90+
1. Download the private key to a safe place, it will be needed to install the app
91+
92+
1. Convert the private key to a PEM file using the following command:
93+
`openssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt -in {DOWNLOADED_FILE_NAME}.pem -out private-key-pkcs8.key`
8194
8295
# Contributors to this project
8396
contributors:

0 commit comments

Comments
 (0)