Skip to content

Commit

Permalink
Website update for main
Browse files Browse the repository at this point in the history
  • Loading branch information
antrea-bot committed Jun 21, 2024
1 parent 46f647d commit 9c251fb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion content/docs/main/docs/api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -11761,5 +11761,5 @@ <h3 id="system.antrea.io/v1beta1.BundleStatus">BundleStatus
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>fbd8312</code>.
on git commit <code>0f75c50</code>.
</em></p>
9 changes: 7 additions & 2 deletions content/docs/main/docs/contributors/code-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Antrea uses [protoc](https://github.com/protocolbuffers/protobuf), [protoc-gen-g
and [protoc-gen-go-grpc](https://github.com/grpc/grpc-go) to generate CNI gRPC service code.

If you make any change to [cni.proto](https://github.com/antrea-io/antrea/blob/main/pkg/apis/cni/v1beta1/cni.proto), you can
re-generate the code by invoking `make codegen`.
re-generate the code by invoking `make codegen`. Make sure that you commit your changes before
running the script, and that you commit the generated code after running it.

## Extension API Resources and Custom Resource Definitions

Expand All @@ -18,7 +19,9 @@ generated codes are located in the conventional paths: `pkg/apis/<resource group
types and `pkg/apis/<resource group>/<version>` for versioned types and `pkg/client/clientset` for
clients.

If you make any change to any `types.go`, you can re-generate the code by invoking `make codegen`.
If you make any change to any `types.go`, you can re-generate the code by invoking `make
codegen`. Make sure that you commit your changes before running the script, and that you commit the
generated code after running it.

## Mocks

Expand All @@ -31,6 +34,8 @@ code for the interface `Baz` defined in the package `pkg/foo/bar` will be genera
`pkg/foo/bar/testing/mock_bar.go`, and you can import it via `pkg/foo/bar/testing`.

Same as above, you can re-generate the mock source code (with `mockgen`) by invoking `make codegen`.
Make sure that you commit your changes before running the script, and that you commit the
generated code after running it.

## Generated Documentation

Expand Down

0 comments on commit 9c251fb

Please sign in to comment.