Skip to content

Commit 1c33a2d

Browse files
committed
Generate docs for v1alpha2
This switches the API doc generation from v1alpha1, to v1alpha2. Signed-off-by: Michael Bridgen <[email protected]>
1 parent ebb2d6a commit 1c33a2d

File tree

4 files changed

+268
-120
lines changed

4 files changed

+268
-120
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ manifests: controller-gen
7676

7777
# Generate API reference documentation
7878
api-docs: gen-crd-api-reference-docs
79-
$(API_REF_GEN) -api-dir=./api/v1alpha1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/image-automation.md
79+
$(API_REF_GEN) -api-dir=./api/v1alpha2 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/image-automation.md
8080

8181
# Run go mod tidy
8282
tidy:

api/v1alpha2/doc.go

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
Copyright 2020 The Flux authors
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
// Package v1alpha2 contains API types for the image v1alpha2 API
18+
// group. The types here are concerned with automated updates to git,
19+
// based on metadata from OCI image registries gathered by the
20+
// image-reflector-controller. There is some rearrangement from
21+
// v1alpha1 to make room for future enhancements.
22+
//
23+
// +kubebuilder:object:generate=true
24+
// +groupName=image.toolkit.fluxcd.io
25+
package v1alpha2

0 commit comments

Comments
 (0)