diff --git a/generator/default/build/client.json b/generator/default/build/client.json index 3deee53..c2ad592 100644 --- a/generator/default/build/client.json +++ b/generator/default/build/client.json @@ -1,6 +1,6 @@ { "name": "client", - "guide": "https://docs.qaskx.one/templates/build/golang/client", + "guide": "{{.SelfFolder}}/client.md", "description": "golang build client template", "variables": [ { diff --git a/generator/default/build/client.md b/generator/default/build/client.md new file mode 100644 index 0000000..8adb1d9 --- /dev/null +++ b/generator/default/build/client.md @@ -0,0 +1,5 @@ +# Client Build Template + +This template generates a client build Powershell +script file that tests and build a Golang pogram. + diff --git a/generator/default/build/definitions/golang/build_linux.tmpl b/generator/default/build/definitions/golang/build_linux.ps1 similarity index 100% rename from generator/default/build/definitions/golang/build_linux.tmpl rename to generator/default/build/definitions/golang/build_linux.ps1 diff --git a/generator/default/build/definitions/golang/build_win.tmpl b/generator/default/build/definitions/golang/build_win.ps1 similarity index 100% rename from generator/default/build/definitions/golang/build_win.tmpl rename to generator/default/build/definitions/golang/build_win.ps1 diff --git a/generator/default/cicd/woodpecker-docker.tmpl b/generator/default/build/definitions/woodpecker/woodpecker-docker.yaml similarity index 100% rename from generator/default/cicd/woodpecker-docker.tmpl rename to generator/default/build/definitions/woodpecker/woodpecker-docker.yaml diff --git a/generator/default/cicd/woodpecker.tmpl b/generator/default/build/definitions/woodpecker/woodpecker.yaml similarity index 100% rename from generator/default/cicd/woodpecker.tmpl rename to generator/default/build/definitions/woodpecker/woodpecker.yaml diff --git a/generator/default/build/golang.json b/generator/default/build/golang.json index faffda9..64eff4e 100644 --- a/generator/default/build/golang.json +++ b/generator/default/build/golang.json @@ -1,6 +1,6 @@ { "name": "golang", - "guide": "https://docs.qaskx.one/templates/build/golang", + "guide": "{{.SelfFolder}}/golang.md", "description": "golang build templates", "variables": [ { @@ -24,14 +24,14 @@ { "engine": "golang", "folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}", - "file_name": "build_win.tmpl", + "file_name": "build_win.ps1", "output_folder": "^/build", "output_name": "golang_windows.ps1" }, { "engine": "golang", "folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}", - "file_name": "build_linux.tmpl", + "file_name": "build_linux.ps1", "output_folder": "^/build", "output_name": "golang_linux.ps1" } diff --git a/generator/default/build/golang.md b/generator/default/build/golang.md new file mode 100644 index 0000000..ce1f177 --- /dev/null +++ b/generator/default/build/golang.md @@ -0,0 +1,5 @@ +# Golang Build Template + +This template generates a build Powershell +script file that tests and build a Golang pogram. + diff --git a/generator/default/build/server.json b/generator/default/build/server.json index 4972aa2..61df2c6 100644 --- a/generator/default/build/server.json +++ b/generator/default/build/server.json @@ -1,6 +1,6 @@ { "name": "server", - "guide": "https://docs.qaskx.one/templates/build/golang/server", + "guide": "{{.SelfFolder}}/server.md", "description": "golang build server template", "variables": [ { diff --git a/generator/default/build/server.md b/generator/default/build/server.md new file mode 100644 index 0000000..e78da4a --- /dev/null +++ b/generator/default/build/server.md @@ -0,0 +1,5 @@ +# Server Build Template + +This template generates a server build Powershell +script file that tests and build a Golang pogram. + diff --git a/generator/default/build/woodpecker.json b/generator/default/build/woodpecker.json new file mode 100644 index 0000000..2c1fd64 --- /dev/null +++ b/generator/default/build/woodpecker.json @@ -0,0 +1,32 @@ +{ + "name": "woodpecker", + "guide": "{{.SelfFolder}}/woodpecker.md", + "description": "Woodpecker CI template", + "variables": [ + { + "label": "Fully Qualified Host Name", + "source": "console", + "default": "", + "name": "Fdqn", + "type": "string", + "value": "" + }, + { + "label": "Design domain", + "source": "console", + "default": "", + "name": "DesignDomain", + "type": "string", + "value": "" + } + ], + "templates": [ + { + "engine": "custom", + "folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}", + "file_name": "woodpecker.yaml", + "output_folder": "^/", + "output_name": ".woodpecker.yaml" + } + ] +} \ No newline at end of file diff --git a/generator/default/build/woodpecker.md b/generator/default/build/woodpecker.md new file mode 100644 index 0000000..3ff7c5d --- /dev/null +++ b/generator/default/build/woodpecker.md @@ -0,0 +1,5 @@ +# Woodpecker CI Build Template + +This template generates a woodpecker CI YAML +file that tests and build a Golang pogram. + diff --git a/generator/default/cicd/cicd.tmpl b/generator/default/cicd/cicd.tmpl deleted file mode 100644 index e69de29..0000000 diff --git a/generator/default/deploy/docker-compose.json b/generator/default/deploy/docker-compose.json index 42bee0d..fc1e470 100644 --- a/generator/default/deploy/docker-compose.json +++ b/generator/default/deploy/docker-compose.json @@ -1,7 +1,7 @@ { "name": "docker-compose", - "guide": "https://docs.qaskx.one/templates/deploy/docker-compose", - "description": "deploy using ssh and docker compose for a refresh image not init/mofify setup", + "guide": "{{.SelfFolder}}/docker-compose.md", + "description": "deploy using ssh and docker compose for a refresh image not init/modify setup", "templates": [ { "engine": "", diff --git a/generator/default/deploy/kong.json b/generator/default/deploy/kong.json index e8e661c..6e75606 100644 --- a/generator/default/deploy/kong.json +++ b/generator/default/deploy/kong.json @@ -1,6 +1,6 @@ { "name": "kong", - "guide": "./kong.md", + "guide": "{{.SelfFolder}}/kong.md", "description": "kong gateway template", "templates": [ { diff --git a/generator/default/deploy/kong.md b/generator/default/deploy/kong.md index 713914c..c441399 100644 --- a/generator/default/deploy/kong.md +++ b/generator/default/deploy/kong.md @@ -1,4 +1,8 @@ -# Kong Generator +# Kong Gateway Generator -Example generator +A Kong gateway can be generated based on the OpenAPI definition that is +published by the project. +The template will use the server and route information to generate a +Kong gateway configuration document into the deploy folder +for the project. diff --git a/generator/default/deploy/traefik.json b/generator/default/deploy/traefik.json index c2d9506..ca84b08 100644 --- a/generator/default/deploy/traefik.json +++ b/generator/default/deploy/traefik.json @@ -1,6 +1,6 @@ { "name": "traefik", - "guide": "https://docs.qaskx.one/templates/deploy/traefik", + "guide": "{{.SelfFolder}}/traefik.md", "description": "traefik template", "templates": [ { diff --git a/generator/default/deploy/traefik.md b/generator/default/deploy/traefik.md new file mode 100644 index 0000000..11ee3c7 --- /dev/null +++ b/generator/default/deploy/traefik.md @@ -0,0 +1,8 @@ +# Traefik Gateway Generator + +A Traefik gateway can be generated based on the OpenAPI definition that is +published by the project. + +The template will use the server information to generate a +Traefik gateway configuration document into the deploy folder +for the project. diff --git a/generator/default/project/golang.json b/generator/default/project/golang.json index 0056dee..6b1b8d5 100644 --- a/generator/default/project/golang.json +++ b/generator/default/project/golang.json @@ -1,6 +1,6 @@ { "name": "golang", - "guide": "https://docs.qaskx.one/templates/project/golang", + "guide": "https://docs.qaskx.one/templates/project/golang.html", "description": "golang project template", "templates": [ { diff --git a/generator/default/project/java.json b/generator/default/project/java.json index 3998b03..2e2e3b9 100644 --- a/generator/default/project/java.json +++ b/generator/default/project/java.json @@ -1,6 +1,6 @@ { "name": "java", - "guide": "https://docs.qaskx.one/templates/project/java", + "guide": "https://docs.qaskx.one/templates/project/java.html", "description": "java project template", "templates": [ { diff --git a/generator/default/project/python.json b/generator/default/project/python.json index b35896f..2c89e4a 100644 --- a/generator/default/project/python.json +++ b/generator/default/project/python.json @@ -1,6 +1,6 @@ { "name": "python", - "guide": "https://docs.qaskx.one/templates/project/python", + "guide": "https://docs.qaskx.one/templates/project/python.html", "description": "python project template", "templates": [ { diff --git a/generator/default/test/definitions/golang/golang.ps1 b/generator/default/test/definitions/golang/golang.ps1 index a4e640b..e358aa4 100644 --- a/generator/default/test/definitions/golang/golang.ps1 +++ b/generator/default/test/definitions/golang/golang.ps1 @@ -1,3 +1,4 @@ +Write-Host "This script executes the golang 'test' function" go test ./... diff --git a/generator/default/test/golang.json b/generator/default/test/golang.json index 95c0008..626d02d 100644 --- a/generator/default/test/golang.json +++ b/generator/default/test/golang.json @@ -1,6 +1,6 @@ { "name": "golang", - "guide": "https://docs.qaskx.one/templates/test/golang", + "guide": "https://docs.qaskx.one/templates/test/golang.html", "description": "golang test templates", "templates": [ { diff --git a/generator/default/test/golang.md b/generator/default/test/golang.md new file mode 100644 index 0000000..1729a98 --- /dev/null +++ b/generator/default/test/golang.md @@ -0,0 +1,5 @@ +# Golang Test Generator + +A Golang test Powershell script can be generated. + +The script is basic.