@tduniec/plugin-template-designer 0.4.0 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/README.md +131 -8
- package/dist/package.json.esm.js +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## [0.4.2](https://github.com/tduniec/template-designer-plugin/compare/template-designer-v0.4.1...template-designer-v0.4.2) (2025-12-23)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* **template-designer:** README changes with release - dx-labs.com ([#59](https://github.com/tduniec/template-designer-plugin/issues/59)) ([9239226](https://github.com/tduniec/template-designer-plugin/commit/9239226633c11cca84d7b23f532ba41601e843f9))
|
|
7
|
+
|
|
8
|
+
## [0.4.1](https://github.com/tduniec/template-designer-plugin/compare/template-designer-v0.4.0...template-designer-v0.4.1) (2025-12-21)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* **template-designer-foundation:** output notation change && node outputs render bringed back ([76bb9e8](https://github.com/tduniec/template-designer-plugin/commit/76bb9e8aedcfa5a152b9f66c5d29428c98bc84b5))
|
|
14
|
+
* **template-designer-foundation:** parameterNodes alignement ([074dceb](https://github.com/tduniec/template-designer-plugin/commit/074dceb1be0fe9479540349564a8379b980df107))
|
|
15
|
+
|
|
1
16
|
# [0.4.0](https://github.com/tduniec/template-designer-plugin/compare/template-designer-v0.3.7...template-designer-v0.4.0) (2025-12-20)
|
|
2
17
|
|
|
3
18
|
|
package/README.md
CHANGED
|
@@ -1,13 +1,136 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Backstage Template Designer Plugin
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**From YAML to Canvas — simplifying Backstage scaffolding**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Empowering the **Democratization of Templates** in Backstage 🚀
|
|
6
|
+
Visually **design, connect, and manage** your Backstage scaffolder templates through an **intuitive drag-and-drop interface** — all inside your Backstage instance.
|
|
7
|
+
No YAML complexity. No coding required. Just creativity. **We are breaking the glass!** templating in Backstage made easy! 🚀
|
|
6
8
|
|
|
7
|
-
##
|
|
9
|
+
## 🖼️ Preview
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
Checkout the video!
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
13
|
+
[▶ Watch the PREVIEW on YouTube](https://youtu.be/Pwzlzvig4-c)
|
|
14
|
+
|
|
15
|
+
## 🚀 Template Designer PRO (Early Access)
|
|
16
|
+
|
|
17
|
+
Template Designer PRO is being built together with DX Labs for teams that need governance, validation, and enterprise support on top of the community edition. Compare Community vs PRO: https://www.dx-labs.com/template-designer#community
|
|
18
|
+
|
|
19
|
+
[<img src="./docs/templateDesignerProBadge.png" alt="Template Designer PRO Early Access" />](https://www.dx-labs.com/template-designer#contact)
|
|
20
|
+
|
|
21
|
+
Early Access gives you:
|
|
22
|
+
- preview builds and private updates
|
|
23
|
+
- influence on the roadmap and feature priority
|
|
24
|
+
- early access discount after the trial period
|
|
25
|
+
|
|
26
|
+
👉 **Request PRO access:** **[dx-labs.com/template-designer#contact](https://www.dx-labs.com/template-designer#contact)**
|
|
27
|
+
(fast & free to join the waitlist)
|
|
28
|
+
|
|
29
|
+
You'll be notified as soon as the first preview is ready.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 🌟 Why “Democratization of Templates”?
|
|
34
|
+
|
|
35
|
+
Backstage templates shouldn’t be just for developers.
|
|
36
|
+
The Template Designer makes **template creation accessible to everyone** — from DevOps engineers to product teams — enabling true **collaboration and transparency** in how your software templates are built and evolve.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 🚀 Features
|
|
41
|
+
|
|
42
|
+
- ⚡ **Drag & Drop Editing** — visually compose your Backstage scaffolder workflows.
|
|
43
|
+
- 🧩 **Three Node Types**
|
|
44
|
+
- **Action Node** – represents a single scaffolder action.
|
|
45
|
+
- **Template Node** – groups multiple actions into a reusable unit.
|
|
46
|
+
- **Output Node** – defines exported values or pipeline results.
|
|
47
|
+
- 💾 **Work with Files** — open existing template definitions or save your flow as a JSON file directly from the UI.
|
|
48
|
+
- 🔄 **Live Flow Connections** — connect nodes with arrows to define execution order.
|
|
49
|
+
- 💡 **Frontend-Only Plugin** — zero backend setup required.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## ⚙️ Installation
|
|
54
|
+
|
|
55
|
+
From your Backstage root directory
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
yarn --cwd packages/app add @tduniec/plugin-template-designer
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
In packages/app/src/App.tsx:
|
|
62
|
+
|
|
63
|
+
```tsx
|
|
64
|
+
import { TemplateDesignerPage } from "@tduniec/plugin-template-designer";
|
|
65
|
+
|
|
66
|
+
const routes = (
|
|
67
|
+
<FlatRoutes>
|
|
68
|
+
{/* other routes */}
|
|
69
|
+
<Route path="/template-designer" element={<TemplateDesignerPage />} />
|
|
70
|
+
</FlatRoutes>
|
|
71
|
+
);
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
In `packages/app/src/components/Root/Root.tsx`:
|
|
75
|
+
|
|
76
|
+
```tsx
|
|
77
|
+
import { SidebarItem } from "@backstage/core-components";
|
|
78
|
+
import { TemplateDesignerIcon } from "@tduniec/plugin-template-designer";
|
|
79
|
+
|
|
80
|
+
<SidebarItem
|
|
81
|
+
icon={TemplateDesignerIcon}
|
|
82
|
+
to="template-designer"
|
|
83
|
+
text="Template Designer"
|
|
84
|
+
/>;
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## ⚙️ Usage
|
|
88
|
+
|
|
89
|
+
Visit your local Backstage instance:
|
|
90
|
+
|
|
91
|
+
http://localhost:3000/template-designer
|
|
92
|
+
|
|
93
|
+
Create and connect nodes, adjust properties, and export your flow as a JSON file.
|
|
94
|
+
You can also open an existing template file, modify it visually, and save your changes.
|
|
95
|
+
|
|
96
|
+
## 💾 File Management
|
|
97
|
+
|
|
98
|
+
Template Designer allows you to easily work with your Backstage scaffolder definitions:
|
|
99
|
+
Open a template file (.json) – load an existing flow directly into the canvas.
|
|
100
|
+
Edit visually – move nodes, adjust connections, rename actions.
|
|
101
|
+
Save – export your template back to a .json file ready for scaffolder integration.
|
|
102
|
+
|
|
103
|
+
_Template Designer can read your registered actions!_
|
|
104
|
+
|
|
105
|
+
## 🧠 Tech Stack
|
|
106
|
+
|
|
107
|
+
- React + TypeScript
|
|
108
|
+
- React Flow
|
|
109
|
+
- Backstage Core Components
|
|
110
|
+
|
|
111
|
+
## 🛠️ Development
|
|
112
|
+
|
|
113
|
+
To run locally during development:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
yarn start
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
This runs a local Backstage app with hot reload support for your plugin.
|
|
120
|
+
|
|
121
|
+
## ❤️ Contributing
|
|
122
|
+
|
|
123
|
+
Template Designer is still fresh out of the oven, so rough edges and open questions are expected—and that’s part of the fun.
|
|
124
|
+
If you spot a bug, have an idea, or simply want to riff on better tooling for templates, please open an issue or PR.
|
|
125
|
+
|
|
126
|
+
Help us push forward the Democratization of Templates in Backstage!
|
|
127
|
+
Ideas, feedback, and PRs are all welcome.
|
|
128
|
+
|
|
129
|
+
## 📄 License
|
|
130
|
+
|
|
131
|
+
Apache-2.0 © 2025 — Created by [tduniec](https://github.com/tduniec)
|
|
132
|
+
|
|
133
|
+
## 🌐 Roadmap
|
|
134
|
+
|
|
135
|
+
TODO -> please help me gather your **[feedback](https://forms.gle/wqBtpNA3SrDoofgM8)** first!
|
|
136
|
+
Take 2 minutes to fill up the **[survey](https://forms.gle/wqBtpNA3SrDoofgM8)**!
|
package/dist/package.json.esm.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tduniec/plugin-template-designer",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "./dist/index.esm.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -75,7 +75,7 @@
|
|
|
75
75
|
"@material-ui/core": "^4.12.4",
|
|
76
76
|
"@material-ui/icons": "^4.11.3",
|
|
77
77
|
"@material-ui/lab": "^4.0.0-alpha.61",
|
|
78
|
-
"@tduniec/plugin-template-designer-foundation": "^0.1.
|
|
78
|
+
"@tduniec/plugin-template-designer-foundation": "^0.1.3",
|
|
79
79
|
"@xyflow/react": "^12.8.6",
|
|
80
80
|
"react-router-dom": "^6.23.0",
|
|
81
81
|
"react-use": "^17.2.4"
|