Skip to content

Commit 449df91

Browse files
committed
docs: app.holos.run/description not cli
The core component documentation on the annotation used to configure the display line for each rendered component was incorrect.
1 parent ac59173 commit 449df91

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

api/core/v1alpha5/types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ type Metadata struct {
263263
// Labels represents a resource selector.
264264
Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
265265
// Annotations represents arbitrary non-identifying metadata. For example
266-
// holos uses the `cli.holos.run/description` annotation to log resources in a
266+
// holos uses the `app.holos.run/description` annotation to log resources in a
267267
// user customized way.
268268
Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
269269
}
@@ -320,7 +320,7 @@ type Component struct {
320320
// resulting BuildPlan.
321321
Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
322322
// Annotations represents arbitrary non-identifying metadata. Use the
323-
// `cli.holos.run/description` to customize the log message of each BuildPlan.
323+
// `app.holos.run/description` to customize the log message of each BuildPlan.
324324
Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
325325
}
326326

doc/md/api/core.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ type Component struct {
188188
// resulting BuildPlan.
189189
Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
190190
// Annotations represents arbitrary non-identifying metadata. Use the
191-
// `cli.holos.run/description` to customize the log message of each BuildPlan.
191+
// `app.holos.run/description` to customize the log message of each BuildPlan.
192192
Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
193193
}
194194
```
@@ -376,7 +376,7 @@ type Metadata struct {
376376
// Labels represents a resource selector.
377377
Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
378378
// Annotations represents arbitrary non-identifying metadata. For example
379-
// holos uses the `cli.holos.run/description` annotation to log resources in a
379+
// holos uses the `app.holos.run/description` annotation to log resources in a
380380
// user customized way.
381381
Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
382382
}

internal/generate/platforms/cue.mod/gen/github.com/holos-run/holos/api/core/v1alpha5/types_go_gen.cue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ package core
290290
labels?: {[string]: string} @go(Labels,map[string]string)
291291

292292
// Annotations represents arbitrary non-identifying metadata. For example
293-
// holos uses the `cli.holos.run/description` annotation to log resources in a
293+
// holos uses the `app.holos.run/description` annotation to log resources in a
294294
// user customized way.
295295
annotations?: {[string]: string} @go(Annotations,map[string]string)
296296
}
@@ -355,7 +355,7 @@ package core
355355
labels?: {[string]: string} @go(Labels,map[string]string)
356356

357357
// Annotations represents arbitrary non-identifying metadata. Use the
358-
// `cli.holos.run/description` to customize the log message of each BuildPlan.
358+
// `app.holos.run/description` to customize the log message of each BuildPlan.
359359
annotations?: {[string]: string} @go(Annotations,map[string]string)
360360
}
361361

version/embedded/patch

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1
1+
2

0 commit comments

Comments
 (0)