From eb740ee24ce54c5501768d43215b990b43729df1 Mon Sep 17 00:00:00 2001 From: Joe Porpeglia Date: Thu, 8 Jul 2021 17:53:10 -0400 Subject: [PATCH 1/7] Use new location for sample software templates Signed-off-by: Joe Porpeglia --- .changeset/wicked-emus-deny.md | 8 ++++++++ .../templates/default-app/app-config.yaml.hbs | 6 +++--- .../sample-templates/all-templates.yaml | 1 - .../sample-templates/local-templates.yaml | 13 ------------- .../sample-templates/remote-templates.yaml | 6 ++++++ 5 files changed, 17 insertions(+), 17 deletions(-) create mode 100644 .changeset/wicked-emus-deny.md delete mode 100644 plugins/scaffolder-backend/sample-templates/local-templates.yaml diff --git a/.changeset/wicked-emus-deny.md b/.changeset/wicked-emus-deny.md new file mode 100644 index 0000000000..2f8fb2a178 --- /dev/null +++ b/.changeset/wicked-emus-deny.md @@ -0,0 +1,8 @@ +--- +'@backstage/create-app': minor +'@backstage/plugin-scaffolder-backend': minor +--- + +Use new location for sample software templates + +See https://github.com/backstage/software-templates diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs index 9a04f38c14..81e4c3a739 100644 --- a/packages/create-app/templates/default-app/app-config.yaml.hbs +++ b/packages/create-app/templates/default-app/app-config.yaml.hbs @@ -100,11 +100,11 @@ catalog: # Backstage example templates - type: url - target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml + target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml rules: - allow: [Template] - type: url - target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml + target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml rules: - allow: [Template] - type: url @@ -112,6 +112,6 @@ catalog: rules: - allow: [Template] - type: url - target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/docs-template/template.yaml + target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml rules: - allow: [Template] diff --git a/plugins/scaffolder-backend/sample-templates/all-templates.yaml b/plugins/scaffolder-backend/sample-templates/all-templates.yaml index a5bcd864b1..fdea8dbd7d 100644 --- a/plugins/scaffolder-backend/sample-templates/all-templates.yaml +++ b/plugins/scaffolder-backend/sample-templates/all-templates.yaml @@ -5,5 +5,4 @@ metadata: description: A collection of all Backstage example templates spec: targets: - - ./local-templates.yaml - ./remote-templates.yaml diff --git a/plugins/scaffolder-backend/sample-templates/local-templates.yaml b/plugins/scaffolder-backend/sample-templates/local-templates.yaml deleted file mode 100644 index 3b3acbae7e..0000000000 --- a/plugins/scaffolder-backend/sample-templates/local-templates.yaml +++ /dev/null @@ -1,13 +0,0 @@ -apiVersion: backstage.io/v1alpha1 -kind: Location -metadata: - name: example-templates-local - description: A collection of locally available Backstage example templates -spec: - targets: - - ./docs-template/template.yaml - - ./react-ssr-template/template.yaml - - ./create-react-app/template.yaml - - ./springboot-grpc-template/template.yaml - - ./v1beta2-demo/template.yaml - - ./pull-request/template.yaml diff --git a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml index 7846a0994e..518a982d69 100644 --- a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml +++ b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml @@ -7,3 +7,9 @@ spec: type: url targets: - https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/create-react-app/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/pull-request/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/v1beta2-demo/template.yaml From cb41e2c1ec2499ae4634e283aaac0a3654302d9e Mon Sep 17 00:00:00 2001 From: Joe Porpeglia Date: Fri, 9 Jul 2021 11:17:32 -0400 Subject: [PATCH 2/7] Update .changeset/wicked-emus-deny.md Co-authored-by: Tim Signed-off-by: Joe Porpeglia --- .changeset/wicked-emus-deny.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/wicked-emus-deny.md b/.changeset/wicked-emus-deny.md index 2f8fb2a178..fe28197b58 100644 --- a/.changeset/wicked-emus-deny.md +++ b/.changeset/wicked-emus-deny.md @@ -3,6 +3,6 @@ '@backstage/plugin-scaffolder-backend': minor --- -Use new location for sample software templates +Moved sample software templates to the [backstage/software-templates](https://github.com/backstage/software-templates) repository. If you previously referenced the sample templates straight from `scaffolder-backend` plugin in the main [backstage/backstage](https://github.com/backstage/backstage) repository in your `app-config.yaml`, these references will need to be updated. See https://github.com/backstage/software-templates From 1a8cde90998184437088412b8b84f144fc1e38f9 Mon Sep 17 00:00:00 2001 From: Joe Porpeglia Date: Fri, 9 Jul 2021 11:24:07 -0400 Subject: [PATCH 3/7] Point to specific commit for sample templates Signed-off-by: Joe Porpeglia --- .../templates/default-app/app-config.yaml.hbs | 6 +++--- .../sample-templates/remote-templates.yaml | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs index 81e4c3a739..404de57f01 100644 --- a/packages/create-app/templates/default-app/app-config.yaml.hbs +++ b/packages/create-app/templates/default-app/app-config.yaml.hbs @@ -100,11 +100,11 @@ catalog: # Backstage example templates - type: url - target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml + target: https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/react-ssr-template/template.yaml rules: - allow: [Template] - type: url - target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml + target: https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/springboot-grpc-template/template.yaml rules: - allow: [Template] - type: url @@ -112,6 +112,6 @@ catalog: rules: - allow: [Template] - type: url - target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml + target: https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/docs-template/template.yaml rules: - allow: [Template] diff --git a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml index 518a982d69..82a5df134b 100644 --- a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml +++ b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml @@ -7,9 +7,9 @@ spec: type: url targets: - https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/create-react-app/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/pull-request/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/v1beta2-demo/template.yaml + - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/create-react-app/template.yaml + - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/docs-template/template.yaml + - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/pull-request/template.yaml + - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/react-ssr-template/template.yaml + - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/springboot-grpc-template/template.yaml + - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/v1beta2-demo/template.yaml From 1165398a9fadc4dbe73c4e0f19af8481c99afb5c Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 16 Jul 2021 11:07:26 +0200 Subject: [PATCH 4/7] Revert "Point to specific commit for sample templates" Hashes don't work with Scaffolder. Signed-off-by: Himanshu Mishra --- .../templates/default-app/app-config.yaml.hbs | 6 +++--- .../sample-templates/remote-templates.yaml | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs index 404de57f01..81e4c3a739 100644 --- a/packages/create-app/templates/default-app/app-config.yaml.hbs +++ b/packages/create-app/templates/default-app/app-config.yaml.hbs @@ -100,11 +100,11 @@ catalog: # Backstage example templates - type: url - target: https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/react-ssr-template/template.yaml + target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml rules: - allow: [Template] - type: url - target: https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/springboot-grpc-template/template.yaml + target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml rules: - allow: [Template] - type: url @@ -112,6 +112,6 @@ catalog: rules: - allow: [Template] - type: url - target: https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/docs-template/template.yaml + target: https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml rules: - allow: [Template] diff --git a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml index 82a5df134b..518a982d69 100644 --- a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml +++ b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml @@ -7,9 +7,9 @@ spec: type: url targets: - https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml - - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/create-react-app/template.yaml - - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/docs-template/template.yaml - - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/pull-request/template.yaml - - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/react-ssr-template/template.yaml - - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/springboot-grpc-template/template.yaml - - https://github.com/backstage/software-templates/blob/3bdd183f052f5971379a4bbfe658829de366decb/scaffolder-templates/v1beta2-demo/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/create-react-app/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/pull-request/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml + - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/v1beta2-demo/template.yaml From 4ea7cd583b7eb9622683fd6d3922611b7da1ea6a Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 16 Jul 2021 11:07:26 +0200 Subject: [PATCH 5/7] chore: update changeset to be patch changes Signed-off-by: Himanshu Mishra --- .changeset/wicked-emus-deny.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/wicked-emus-deny.md b/.changeset/wicked-emus-deny.md index fe28197b58..ff6788dbb2 100644 --- a/.changeset/wicked-emus-deny.md +++ b/.changeset/wicked-emus-deny.md @@ -1,6 +1,6 @@ --- -'@backstage/create-app': minor -'@backstage/plugin-scaffolder-backend': minor +'@backstage/create-app': patch +'@backstage/plugin-scaffolder-backend': patch --- Moved sample software templates to the [backstage/software-templates](https://github.com/backstage/software-templates) repository. If you previously referenced the sample templates straight from `scaffolder-backend` plugin in the main [backstage/backstage](https://github.com/backstage/backstage) repository in your `app-config.yaml`, these references will need to be updated. From 8b135fa79b39db8daebabc0307b90f1c893bb5d6 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 16 Jul 2021 11:07:26 +0200 Subject: [PATCH 6/7] update remote urls to use main branch Signed-off-by: Himanshu Mishra --- .../sample-templates/remote-templates.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml index 518a982d69..81787b4297 100644 --- a/plugins/scaffolder-backend/sample-templates/remote-templates.yaml +++ b/plugins/scaffolder-backend/sample-templates/remote-templates.yaml @@ -7,9 +7,9 @@ spec: type: url targets: - https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/create-react-app/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/docs-template/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/pull-request/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/react-ssr-template/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/springboot-grpc-template/template.yaml - - https://github.com/backstage/software-templates/blob/master/scaffolder-templates/v1beta2-demo/template.yaml + - https://github.com/backstage/software-templates/blob/main/scaffolder-templates/create-react-app/template.yaml + - https://github.com/backstage/software-templates/blob/main/scaffolder-templates/docs-template/template.yaml + - https://github.com/backstage/software-templates/blob/main/scaffolder-templates/pull-request/template.yaml + - https://github.com/backstage/software-templates/blob/main/scaffolder-templates/react-ssr-template/template.yaml + - https://github.com/backstage/software-templates/blob/main/scaffolder-templates/springboot-grpc-template/template.yaml + - https://github.com/backstage/software-templates/blob/main/scaffolder-templates/v1beta2-demo/template.yaml From 529fd3285b5ac2c87c9dcc2541f266f7163f83bb Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 16 Jul 2021 11:07:26 +0200 Subject: [PATCH 7/7] add an example of working with a local template Signed-off-by: Himanshu Mishra --- .../scaffolder-backend/sample-templates/all-templates.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/plugins/scaffolder-backend/sample-templates/all-templates.yaml b/plugins/scaffolder-backend/sample-templates/all-templates.yaml index fdea8dbd7d..2d5adb8e3b 100644 --- a/plugins/scaffolder-backend/sample-templates/all-templates.yaml +++ b/plugins/scaffolder-backend/sample-templates/all-templates.yaml @@ -6,3 +6,9 @@ metadata: spec: targets: - ./remote-templates.yaml + +# For local development of a template, you can reference your local templates here. +# Examples: +# +# - ./local-template/template.yaml +# - ../all-templates/local/template.yaml