Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update ship template functions list for ship 0.51.1 #903

Merged
merged 1 commit into from
Sep 18, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions content/docs/ship/template-functions/template-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,10 +268,20 @@ Implementations of these functions can be found [here](https://github.com/replic
func ShipCustomerRelease() string
```
ShipCustomerRelease returns a copy of the release metadata struct, marshalled as yaml.
Config specs, collect specs, analyze specs, github contents and images are not included.
```yaml
'{{repl ShipCustomerRelease }}'
```

{{< template_function name="ShipCustomerReleaseFull" >}}
```go
func ShipCustomerReleaseFull() string
```
ShipCustomerReleaseFull returns a copy of the release metadata struct, marshalled as yaml.
```yaml
'{{repl ShipCustomerReleaseFull }}'
```

{{< template_function name="EntitlementValue" >}}
```go
func EntitlementValue(name string) string
Expand Down Expand Up @@ -299,6 +309,15 @@ CollectSpec returns the Collect Spec currently promoted to the channel to which
'{{repl CollectSpec }}'
```

{{< template_function name="ConfigSpec" >}}
```go
func ConfigSpec() string
```
ConfigSpec returns the Config Spec for the current ship release.
```yaml
'{{repl ConfigSpec }}'
```

{{< template_function name="AnalyzeSpec" >}}
```go
func AnalyzeSpec() string
Expand Down