From d1ccd52a9d58d1dcc312a8738fa3a1b79cded8c1 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 15 Jan 2021 16:17:11 +0100 Subject: [PATCH 1/6] cli: Append credentials to create-github-app output name --- packages/cli/src/commands/create-github-app/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cli/src/commands/create-github-app/index.ts b/packages/cli/src/commands/create-github-app/index.ts index b8d232674e..2dd0d31232 100644 --- a/packages/cli/src/commands/create-github-app/index.ts +++ b/packages/cli/src/commands/create-github-app/index.ts @@ -26,7 +26,7 @@ import { GithubCreateAppServer } from './GithubCreateAppServer'; export default async (org: string) => { const { slug, name, ...config } = await GithubCreateAppServer.run({ org }); - const fileName = `github-app-${slug}.yaml`; + const fileName = `github-app-${slug}-credentials.yaml`; const content = `# Name: ${name}\n${stringifyYaml(config)}`; await fs.writeFile(paths.resolveTargetRoot(fileName), content); console.log(`GitHub App configuration written to ${chalk.cyan(fileName)}`); From c48119248846e45d572e3065ae2ad0b78e46572f Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 15 Jan 2021 16:25:29 +0100 Subject: [PATCH 2/6] gitignore: Ignore *-credentials.yaml --- .gitignore | 3 +++ packages/create-app/templates/default-app/.gitignore.hbs | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 3334bf956d..57ad74c5cc 100644 --- a/.gitignore +++ b/.gitignore @@ -130,3 +130,6 @@ site # Local configuration files *.local.yaml + +# Sensitive credentials +*-credentials.yaml diff --git a/packages/create-app/templates/default-app/.gitignore.hbs b/packages/create-app/templates/default-app/.gitignore.hbs index 5f5cc739f4..4adebc5adc 100644 --- a/packages/create-app/templates/default-app/.gitignore.hbs +++ b/packages/create-app/templates/default-app/.gitignore.hbs @@ -30,4 +30,7 @@ dist-types site # Local configuration files -*.local.yaml \ No newline at end of file +*.local.yaml + +# Sensitive credentials +*-credentials.yaml From b604a9d41192b643436f36283b8fdd43235f14b5 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 15 Jan 2021 16:35:06 +0100 Subject: [PATCH 3/6] Add changeset --- .changeset/loud-kids-dance.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .changeset/loud-kids-dance.md diff --git a/.changeset/loud-kids-dance.md b/.changeset/loud-kids-dance.md new file mode 100644 index 0000000000..035e038f58 --- /dev/null +++ b/.changeset/loud-kids-dance.md @@ -0,0 +1,8 @@ +--- +'@backstage/cli': patch +'@backstage/create-app': patch +--- + +Append `-credentials.yaml` to credentials file generated by `backstage-cli create-github-app`. + +Add `*-credentials.yaml` to gitignore to prevent accidental commits. From 7d2a390a4f27107c23eabdecc95bfee7a8286a39 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 15 Jan 2021 17:21:12 +0100 Subject: [PATCH 4/6] Warn user about sensitive credentials --- .changeset/loud-kids-dance.md | 5 +---- packages/cli/src/commands/create-github-app/index.ts | 5 +++++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.changeset/loud-kids-dance.md b/.changeset/loud-kids-dance.md index 035e038f58..4fd32ac348 100644 --- a/.changeset/loud-kids-dance.md +++ b/.changeset/loud-kids-dance.md @@ -1,8 +1,5 @@ --- '@backstage/cli': patch -'@backstage/create-app': patch --- -Append `-credentials.yaml` to credentials file generated by `backstage-cli create-github-app`. - -Add `*-credentials.yaml` to gitignore to prevent accidental commits. +Append `-credentials.yaml` to credentials file generated by `backstage-cli create-github-app` and display warning about sensitive contents. diff --git a/packages/cli/src/commands/create-github-app/index.ts b/packages/cli/src/commands/create-github-app/index.ts index 2dd0d31232..cd9e8dbe09 100644 --- a/packages/cli/src/commands/create-github-app/index.ts +++ b/packages/cli/src/commands/create-github-app/index.ts @@ -30,5 +30,10 @@ export default async (org: string) => { const content = `# Name: ${name}\n${stringifyYaml(config)}`; await fs.writeFile(paths.resolveTargetRoot(fileName), content); console.log(`GitHub App configuration written to ${chalk.cyan(fileName)}`); + console.log( + chalk.yellow( + 'This file contains sensitive credentials, it should not be committed to version control and handled with care!', + ), + ); // TODO: log instructions on how to use the newly created app configuration. }; From 92dbbcedd760bbab615bf5a2fabf4d988e4dc42b Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 15 Jan 2021 17:21:44 +0100 Subject: [PATCH 5/6] Add changeset for create-app --- .changeset/spoon-fork.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .changeset/spoon-fork.md diff --git a/.changeset/spoon-fork.md b/.changeset/spoon-fork.md new file mode 100644 index 0000000000..a9d5e42237 --- /dev/null +++ b/.changeset/spoon-fork.md @@ -0,0 +1,11 @@ +--- +'@backstage/create-app': patch +--- + +Add `*-credentials.yaml` to gitignore to prevent accidental commits of sensitive credential information. + +To apply this change to an existing installation, add this line to your `.gitignore` + +```gitignore +*-credentials.yaml +``` From d69d5d5ca8018f8efa8ee0f6414dab4107508d4f Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 15 Jan 2021 17:25:33 +0100 Subject: [PATCH 6/6] Add comment to changeset --- .changeset/spoon-fork.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.changeset/spoon-fork.md b/.changeset/spoon-fork.md index a9d5e42237..5b8620f94e 100644 --- a/.changeset/spoon-fork.md +++ b/.changeset/spoon-fork.md @@ -4,8 +4,9 @@ Add `*-credentials.yaml` to gitignore to prevent accidental commits of sensitive credential information. -To apply this change to an existing installation, add this line to your `.gitignore` +To apply this change to an existing installation, add these lines to your `.gitignore` ```gitignore +# Sensitive credentials *-credentials.yaml ```