From 00448abb0343cbab1ff8aa3ce6393ec0c3688158 Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 26 Jan 2021 15:47:23 +0100 Subject: [PATCH 1/5] chore: updating docs reference to integrations condfig --- .../software-templates/installation.md | 28 +++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index 724b86aed1..6d516eef3a 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -173,7 +173,12 @@ and access to a running Docker daemon. You can create a GitHub access token docs on creating private GitHub access tokens is available [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). Note that the need for private GitHub access tokens will be replaced with GitHub -Apps integration further down the line. +Apps integration further down the line by using the existing `integrations` +config. + +> Note: Some of this config may already be setup part of your `app-config.yaml`. +> We're moving away from the duplciated config for authentication in the +> `scaffolder` section and using `integrations` instead. #### GitHub @@ -187,11 +192,14 @@ by specifying `visibility` option. Valid options are `public`, `private` and public within the enterprise. ```yaml -scaffolder: +integrations: github: - token: - $env: GITHUB_TOKEN - visibility: public # or 'internal' or 'private' + - host: github.com + token: + $env: GITHUB_TOKEN + +scaffolder: + visibility: public # or 'internal' or 'private' ``` #### GitLab @@ -201,10 +209,9 @@ allows to configure the private access token and the base URL of a GitLab instance: ```yaml -scaffolder: +integrations: gitlab: - api: - baseUrl: https://gitlab.com + - host: gitlab.com token: $env: GITLAB_TOKEN ``` @@ -218,10 +225,9 @@ will hopefully support on-prem installations as well but that has not been verified. ```yaml -scaffolder: +integrations: azure: - baseUrl: https://dev.azure.com/{your-organization} - api: + - host: dev.azure.com token: $env: AZURE_TOKEN ``` From 46533ed01b75c8751f6c7c05ffb1794098f8cd2c Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 26 Jan 2021 15:53:32 +0100 Subject: [PATCH 2/5] chore: fix the config key for scaffolderr --- docs/features/software-templates/installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index 6d516eef3a..c2f95f26ea 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -199,7 +199,8 @@ integrations: $env: GITHUB_TOKEN scaffolder: - visibility: public # or 'internal' or 'private' + github: + visibility: public # or 'internal' or 'private' ``` #### GitLab From 2f547a668fea41611515737741136ebd49ecfc26 Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 26 Jan 2021 16:03:26 +0100 Subject: [PATCH 3/5] chore: fix spelling mistake --- docs/features/software-templates/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index c2f95f26ea..c0bc10fbe0 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -177,7 +177,7 @@ Apps integration further down the line by using the existing `integrations` config. > Note: Some of this config may already be setup part of your `app-config.yaml`. -> We're moving away from the duplciated config for authentication in the +> We're moving away from the duplicated config for authentication in the > `scaffolder` section and using `integrations` instead. #### GitHub From e77a8dc14e905e728bcb685cbeee56fad73d01d6 Mon Sep 17 00:00:00 2001 From: Ben Lambert Date: Tue, 26 Jan 2021 17:02:03 +0100 Subject: [PATCH 4/5] Update docs/features/software-templates/installation.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw --- docs/features/software-templates/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index c0bc10fbe0..a00de1aa5e 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -176,7 +176,7 @@ Note that the need for private GitHub access tokens will be replaced with GitHub Apps integration further down the line by using the existing `integrations` config. -> Note: Some of this config may already be setup part of your `app-config.yaml`. +> Note: Some of this configuration may already be set up as part of your `app-config.yaml`. > We're moving away from the duplicated config for authentication in the > `scaffolder` section and using `integrations` instead. From cb99b8fc1dcbb8b08e531e4842258ac9eda39775 Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 26 Jan 2021 17:07:27 +0100 Subject: [PATCH 5/5] chore: prettier makes pretty --- docs/features/software-templates/installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index a00de1aa5e..8d2fa7727d 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -176,9 +176,9 @@ Note that the need for private GitHub access tokens will be replaced with GitHub Apps integration further down the line by using the existing `integrations` config. -> Note: Some of this configuration may already be set up as part of your `app-config.yaml`. -> We're moving away from the duplicated config for authentication in the -> `scaffolder` section and using `integrations` instead. +> Note: Some of this configuration may already be set up as part of your +> `app-config.yaml`. We're moving away from the duplicated config for +> authentication in the `scaffolder` section and using `integrations` instead. #### GitHub