Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: support single line private keys #1368

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
merged 8 commits into from
Nov 9, 2021
Merged

feat: support single line private keys #1368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
153fbb4
feat: support single line private keys
toast-gear Nov 2, 2021
80cfd3c
docs: docs for the new key storage options
Nov 2, 2021
20b2695
docs: use original doc style
Nov 2, 2021
fdf5359
style: use single quotes
Nov 2, 2021
df506f7
chore: fmt ts files
Nov 2, 2021
4d9b090
docs: use original language more
toast-gear Nov 2, 2021
7f54745
docs: use the original language more
toast-gear Nov 2, 2021
18d502f
fix: use correct char code for new line
toast-gear Nov 4, 2021
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ resource "aws_iam_service_linked_role" "spot" {

Next create a second terraform workspace and initiate the module, or adapt one of the [examples](./examples).

Note that `github_app.key_base64` needs to be the base64-encoded `.pem` file, i.e., the output of `base64 app.private-key.pem` (not directly the content of `app.private-key.pem`).
Note that `github_app.key_base64` needs to be a base64-encoded string of the `.pem` file i.e. the output of `base64 app.private-key.pem`. The decoded string can either be a multiline value or a single line value with new lines represented with literal `\n` characters.

```terraform
module "github-runner" {
Expand Down
7 changes: 6 additions & 1 deletion modules/runners/lambdas/runners/src/scale-runners/gh-auth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,12 @@ async function createAuth(installationId: number | undefined, ghesApiUrl: string
privateKey: Buffer.from(
await getParameterValue(process.env.PARAMETER_GITHUB_APP_KEY_BASE64_NAME),
'base64',
).toString(),
// replace literal \n characters with new lines to allow the key to be stored as a
// single line variable. This logic should match how the GitHub Terraform provider
// processes private keys to retain compatibility between the projects
)
.toString()
.replace('/[\\n]/g', String.fromCharCode(10)),
};
if (installationId) authOptions = { ...authOptions, installationId };

Expand Down