Skip to content

Commit 841ae98

Browse files
committed
ci: review apidoc task
Signed-off-by: Francesco Canovai <[email protected]>
1 parent 0701fec commit 841ae98

File tree

2 files changed

+3
-24
lines changed

2 files changed

+3
-24
lines changed

Taskfile.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,15 @@ tasks:
7373
desc: Update the API Reference section of the documentation
7474
env:
7575
# renovate: datasource=git-refs depName=genref lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
76-
DAGGER_UNCOMMITTED_SHA: ac27cc7677fc42ea129fd3c1aa2b2894aad3a246
76+
DAGGER_APIDOC_SHA: ac27cc7677fc42ea129fd3c1aa2b2894aad3a246
7777
cmds:
78-
- GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/genref@${DAGGER_UNCOMMITTED_SHA} genref --source .
78+
- GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/genref@${DAGGER_APIDOC_SHA} genref --source .
7979
--args "-c=config.yaml" --args "-o=src" --args "-include=plugin-barman-cloud"
8080
file --path src/plugin-barman-cloud.v1.md
8181
export --path docs/src/plugin-barman-cloud.v1.md
8282
sources:
8383
- ./api/**/*.go
84+
- ./docs/config.yaml
8485
generates:
8586
- ./docs/src/plugin-barman-cloud.v1.md
8687

docs/config.yaml

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,8 @@ hiddenMemberFields:
22
- "TypeMeta"
33

44
externalPackages:
5-
- match: ^github\.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1\.RelabelConfig$
6-
target: https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig
7-
- match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.Duration$
8-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration
9-
- match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.GroupVersionKind$
10-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind
11-
- match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.GroupVersionResource$
12-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource
13-
- match: ^k8s\.io/apimachinery/pkg/types\.UID$
14-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID
15-
- match: ^k8s\.io/apimachinery/pkg/runtime\.RawExtension$
16-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension
17-
- match: ^k8s\.io/apimachinery/pkg/api/resource\.Quantity$
18-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity
19-
- match: ^k8s\.io/apimachinery/pkg/api/resource\.QuantityValue$
20-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue
21-
- match: ^k8s\.io/apimachinery/pkg/runtime\.Unknown$
22-
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown
23-
- match: ^time\.Duration$
24-
target: https://pkg.go.dev/time#Duration
255
- match: ^k8s\.io/(api|apimachinery/pkg/apis)/
266
target: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#{{- lower .TypeIdentifier -}}-{{- arrIndex .PackageSegments -1 -}}-{{- arrIndex .PackageSegments -2 -}}
27-
- match: ^github\.com/cloudnative-pg/machinery
28-
target: https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#{{- .TypeIdentifier }}
297
- match: ^github\.com/cloudnative-pg/barman-cloud
308
target: https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api/#{{- .TypeIdentifier }}
319

0 commit comments

Comments
 (0)