Katenary/katenary
2
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases 15 Wiki Activity

feat(repo): Go to repo.katenary.io

Browse Source
This commit is contained in:
Patrice Ferlet
2025-08-19 23:09:50 +02:00
parent c85e61f5d0
commit d34f97fa5d
43 changed files with 238 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/docs/packages/internal/generator/katenaryfile.md
View File

@@ -3,7 +3,7 @@
# katenaryfile
```go
import "github.com/katenary/katenary/internal/generator/katenaryfile"
import "repo.katenary.io/katenary/katenary/internal/generator/katenaryfile"
```
Package katenaryfile is a package for reading and writing katenary files.
@@ -12,7 +12,7 @@ A katenary file, named "katenary.yml" or "katenary.yaml", is a file where you ca
Formely, the file describe the same structure as in labels, and so that can be validated and completed by LSP. It also ease the use of katenary.
## func [GenerateSchema](<https://github.com/katenary/katenary/blob/master/internal/generator/katenaryfile/main.go#L137>)
## func [GenerateSchema](<https://repo.katenary.io/Katenary/katenary/blob/feat-move-to-gitea/internal/generator/katenaryfile/main.go#L138>)
```go
func GenerateSchema() string
@@ -21,7 +21,7 @@ func GenerateSchema() string
GenerateSchema generates the schema for the katenary.yaml file.
<a name="OverrideWithConfig"></a>
## func [OverrideWithConfig](<https://github.com/katenary/katenary/blob/master/internal/generator/katenaryfile/main.go#L49>)
## func [OverrideWithConfig](<https://repo.katenary.io/Katenary/katenary/blob/feat-move-to-gitea/internal/generator/katenaryfile/main.go#L50>)
```go
func OverrideWithConfig(project *types.Project)
@@ -30,7 +30,7 @@ func OverrideWithConfig(project *types.Project)
OverrideWithConfig overrides the project with the katenary.yaml file. It will set the labels of the services with the values from the katenary.yaml file. It work in memory, so it will not modify the original project.
<a name="Service"></a>
## type [Service](<https://github.com/katenary/katenary/blob/master/internal/generator/katenaryfile/main.go#L27-L44>)
## type [Service](<https://repo.katenary.io/Katenary/katenary/blob/feat-move-to-gitea/internal/generator/katenaryfile/main.go#L28-L45>)
Service is a struct that contains the service configuration for katenary
@@ -56,7 +56,7 @@ type Service struct {
```
<a name="StringOrMap"></a>
## type [StringOrMap](<https://github.com/katenary/katenary/blob/master/internal/generator/katenaryfile/main.go#L24>)
## type [StringOrMap](<https://repo.katenary.io/Katenary/katenary/blob/feat-move-to-gitea/internal/generator/katenaryfile/main.go#L25>)
StringOrMap is a struct that can be either a string or a map of strings. It's a helper struct to unmarshal the katenary.yaml file and produce the schema