馃悰: sync kb binary from source code for docs #3520
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/S
|
/test pull-kubebuilder-e2e-k8s-1-26-0 |
Makefile
Outdated
| @@ -63,18 +63,14 @@ install: build ## Build and install the binary with the current source code. Use | |||
| ##@ Development | |||
|
|
|||
| .PHONY: generate | |||
| generate: generate-testdata generate-docs ## Update/generate all mock data. You should run this commands to update the mock data after your changes. | |||
| generate: generate-testdata check-docs ## Update/generate all mock data. You should run this commands to update the mock data after your changes. | |||
There was a problem hiding this comment.
The target generate has the purpose to generate only and not check
The check is used in the CI only for we ensure that the docs were properly generate.
IMO it should work at the same way of generate-testdata and check-testdata.
There was a problem hiding this comment.
Sounds good!
I just follow your idea and make the corresponding updates:
- Create a new
hack/docs/generate.shthat builds thekb executablefrom source code and run the go code to re-generate docs samples - Modify the target
generate-docsto callhack/docs/generate.sh - Modify the target
check-docsto drop unnecessary import and callhack/docs/generate.sh
Let me know how you'd like this or if I'm understanding wrong :)
Kavinjsir
force-pushed
the
fix/build-kb-for-docs-generation
branch
from
1e75efd
to
dfe3ab8
Compare
k8s-ci-robot
added
size/M
camilamacedo86
approved these changes
Aug 15, 2023
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, Kavinjsir The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
camilamacedo86
merged commit 68abac1
into
kubernetes-sigs:master
18 of 20 checks passed
k8s-ci-robot
added
the
approved
Sajiyah-Salat
pushed a commit
to Sajiyah-Salat/kubebuilder
that referenced
this pull request
Aug 22, 2023
fix: sync kb binary from source code for docs
yyy1000
pushed a commit
to yyy1000/kubebuilder
that referenced
this pull request
Aug 27, 2023
fix: sync kb binary from source code for docs
yyy1000
added a commit
to yyy1000/kubebuilder
that referenced
this pull request
Aug 27, 2023
feat: get data feat: add change feat: remove log feat: add e2e test build(deps): bump golang.org/x/tools from 0.11.0 to 0.12.0 Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.11.0 to 0.12.0. - [Release notes](https://github.com/golang/tools/releases) - [Commits](golang/tools@v0.11.0...v0.12.0) --- updated-dependencies: - dependency-name: golang.org/x/tools dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> chore(docs): change folder pkg to internal/controller in the migration guide fix: ensure external plugin can scaffold files in new dirs :seedling: Image name edge cases covered (kubernetes-sigs#3514) imagename edge case cover :seedling: logs info updated (kubernetes-sigs#3512) logs info updated :bug: fix doc preview 馃悰: sync kb binary from source code for docs (kubernetes-sigs#3520) fix: sync kb binary from source code for docs :bug: fix typos in scaffolded makefiles :book: fix escaped html in markdown code segments :bug: (go/v4) fix makefile target to build images ensuring its single responsability refactor: externalize cfg :bug: (deployimage): fix e2e tests which are using go/v3 which is deprecated. Ensure that we are using the go/v4 ensure that we call go tidy when we generate sample docs :sparkles: (Kustomize/v2, go/v4): upgrade controller-tools from 0.12.0 to 0.13.0 (kubernetes-sigs#3561) (go/v4): Upgrade controller-tools from 0.12.0 to v0.13.0 :sparkles: improve logs from alpha command generate :bug: (deployimage/v1-beta1): fix scaffold with multigroup and add optional plugins to multigroup sample to validate changes :bug: change deprecated warning to yellow feat: remove quota fix: add space fix: change kind Update test/e2e/alphagenerate/generate_test.go Co-authored-by: Tony (TianYi) <kavinjsir@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR aims to ensure that the
Kubebuilder binaryused for docs generation is built from the source code so that the docs can be updated corresponding to the latest code change.hack/docs/generate.shthat builds the kb executable from source code and run the go code to re-generate docs samplesgenerate-docsto callhack/docs/generate.shcheck-docsto drop unnecessary import and callhack/docs/generate.sh/tmp/kubebuilder/bin/kubebuilderwhich is generated bybuild_kb(instead of the default kb from user's os env).Motivation:
Partially resolve #3435
See comments: