Updating and refactoring templates

Draft documentation created
main
Tom Peltonen 2024-04-29 18:57:01 +10:00
parent 57d4ae0b6e
commit 971cf91555
24 changed files with 85 additions and 15 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "client", "name": "client",
"guide": "https://docs.qaskx.one/templates/build/golang/client", "guide": "{{.SelfFolder}}/client.md",
"description": "golang build client template", "description": "golang build client template",
"variables": [ "variables": [
{ {

View File

@ -0,0 +1,5 @@
# Client Build Template
This template generates a client build Powershell
script file that tests and build a Golang pogram.

View File

@ -1,6 +1,6 @@
{ {
"name": "golang", "name": "golang",
"guide": "https://docs.qaskx.one/templates/build/golang", "guide": "{{.SelfFolder}}/golang.md",
"description": "golang build templates", "description": "golang build templates",
"variables": [ "variables": [
{ {
@ -24,14 +24,14 @@
{ {
"engine": "golang", "engine": "golang",
"folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}", "folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}",
"file_name": "build_win.tmpl", "file_name": "build_win.ps1",
"output_folder": "^/build", "output_folder": "^/build",
"output_name": "golang_windows.ps1" "output_name": "golang_windows.ps1"
}, },
{ {
"engine": "golang", "engine": "golang",
"folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}", "folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}",
"file_name": "build_linux.tmpl", "file_name": "build_linux.ps1",
"output_folder": "^/build", "output_folder": "^/build",
"output_name": "golang_linux.ps1" "output_name": "golang_linux.ps1"
} }

View File

@ -0,0 +1,5 @@
# Golang Build Template
This template generates a build Powershell
script file that tests and build a Golang pogram.

View File

@ -1,6 +1,6 @@
{ {
"name": "server", "name": "server",
"guide": "https://docs.qaskx.one/templates/build/golang/server", "guide": "{{.SelfFolder}}/server.md",
"description": "golang build server template", "description": "golang build server template",
"variables": [ "variables": [
{ {

View File

@ -0,0 +1,5 @@
# Server Build Template
This template generates a server build Powershell
script file that tests and build a Golang pogram.

View File

@ -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"
}
]
}

View File

@ -0,0 +1,5 @@
# Woodpecker CI Build Template
This template generates a woodpecker CI YAML
file that tests and build a Golang pogram.

View File

@ -1,7 +1,7 @@
{ {
"name": "docker-compose", "name": "docker-compose",
"guide": "https://docs.qaskx.one/templates/deploy/docker-compose", "guide": "{{.SelfFolder}}/docker-compose.md",
"description": "deploy using ssh and docker compose for a refresh image not init/mofify setup", "description": "deploy using ssh and docker compose for a refresh image not init/modify setup",
"templates": [ "templates": [
{ {
"engine": "", "engine": "",

View File

@ -1,6 +1,6 @@
{ {
"name": "kong", "name": "kong",
"guide": "./kong.md", "guide": "{{.SelfFolder}}/kong.md",
"description": "kong gateway template", "description": "kong gateway template",
"templates": [ "templates": [
{ {

View File

@ -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.

View File

@ -1,6 +1,6 @@
{ {
"name": "traefik", "name": "traefik",
"guide": "https://docs.qaskx.one/templates/deploy/traefik", "guide": "{{.SelfFolder}}/traefik.md",
"description": "traefik template", "description": "traefik template",
"templates": [ "templates": [
{ {

View File

@ -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.

View File

@ -1,6 +1,6 @@
{ {
"name": "golang", "name": "golang",
"guide": "https://docs.qaskx.one/templates/project/golang", "guide": "https://docs.qaskx.one/templates/project/golang.html",
"description": "golang project template", "description": "golang project template",
"templates": [ "templates": [
{ {

View File

@ -1,6 +1,6 @@
{ {
"name": "java", "name": "java",
"guide": "https://docs.qaskx.one/templates/project/java", "guide": "https://docs.qaskx.one/templates/project/java.html",
"description": "java project template", "description": "java project template",
"templates": [ "templates": [
{ {

View File

@ -1,6 +1,6 @@
{ {
"name": "python", "name": "python",
"guide": "https://docs.qaskx.one/templates/project/python", "guide": "https://docs.qaskx.one/templates/project/python.html",
"description": "python project template", "description": "python project template",
"templates": [ "templates": [
{ {

View File

@ -1,3 +1,4 @@
Write-Host "This script executes the golang 'test' function"
go test ./... go test ./...

View File

@ -1,6 +1,6 @@
{ {
"name": "golang", "name": "golang",
"guide": "https://docs.qaskx.one/templates/test/golang", "guide": "https://docs.qaskx.one/templates/test/golang.html",
"description": "golang test templates", "description": "golang test templates",
"templates": [ "templates": [
{ {

View File

@ -0,0 +1,5 @@
# Golang Test Generator
A Golang test Powershell script can be generated.
The script is basic.