8000 Eliminate kicbase generate docs by nirs · Pull Request #21 · nirs/minikube · GitHub
[go: up one dir, main page]

Skip to content

Eliminate kicbase generate docs - #21

Closed
nirs wants to merge 38 commits into
masterfrom
eliminate-kicbase-generate-docs
Closed

nirs wants to merge 38 commits into
masterfrom
eliminate-kicbase-generate-docs

Conversation

@nirs
@nirs nirs commented Nov 22, 2026
Copy link
Copy Markdown
Owner

No description provided.

nirs and others added 30 commits November 17, 2026 00:42
update-pr pushed with `MINIKUBE_BOT_PAT || GITHUB_TOKEN`, so a missing
bot PAT silently used the upstream GITHUB_TOKEN. That token has
contents: write on the base repository: pushing a fork head then failed
with 403, while a same-repository branch could be pushed as
github-actions[bot]. Either way the misconfiguration was invisible, and
the job held an upstream write capability the intended credential does
not need.

Choose the token by repository instead: kubernetes/minikube uses
MINIKUBE_BOT_PAT, a fork uses its own GITHUB_TOKEN for its own PR
branch. Keep the bot PAT non-empty with a descriptive fallback so gh
never treats GH_TOKEN as unset, and pass the fork token as
FORK_GITHUB_TOKEN so the default GITHUB_TOKEN name never enters the
environment and gh has nothing to fall back to.

contents: write stays on update-pr for the fork run; upstream does not
use it.
Bumps the k8s-dependencies group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [k8s.io/api](https://github.com/kubernetes/api) | `0.37.1` | `0.37.2` |
| [k8s.io/apimachinery](https://github.com/kubernetes/apimachinery) | `0.37.1` | `0.37.2` |
| [k8s.io/client-go](https://github.com/kubernetes/client-go) | `0.37.1` | `0.37.2` |
| [k8s.io/cluster-bootstrap](https://github.com/kubernetes/cluster-bootstrap) | `0.37.1` | `0.37.2` |
| [k8s.io/component-base](https://github.com/kubernetes/component-base) | `0.37.1` | `0.37.2` |
| [k8s.io/kubectl](https://github.com/kubernetes/kubectl) | `0.37.1` | `0.37.2` |


Updates `k8s.io/api` from 0.37.1 to 0.37.2
- [Commits](kubernetes/api@v0.37.1...v0.37.2)

Updates `k8s.io/apimachinery` from 0.37.1 to 0.37.2
- [Commits](kubernetes/apimachinery@v0.37.1...v0.37.2)

Updates `k8s.io/client-go` from 0.37.1 to 0.37.2
- [Changelog](https://github.com/kubernetes/client-go/blob/master/CHANGELOG.md)
- [Commits](kubernetes/client-go@v0.37.1...v0.37.2)

Updates `k8s.io/cluster-bootstrap` from 0.37.1 to 0.37.2
- [Commits](kubernetes/cluster-bootstrap@v0.37.1...v0.37.2)

Updates `k8s.io/component-base` from 0.37.1 to 0.37.2
- [Commits](kubernetes/component-base@v0.37.1...v0.37.2)

Updates `k8s.io/kubectl` from 0.37.1 to 0.37.2
- [Commits](kubernetes/kubectl@v0.37.1...v0.37.2)

---
updated-dependencies:
- dependency-name: k8s.io/api
  dependency-version: 0.37.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: k8s-dependencies
- dependency-name: k8s.io/apimachinery
  dependency-version: 0.37.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: k8s-dependencies
- dependency-name: k8s.io/client-go
  dependency-version: 0.37.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: k8s-dependencies
- dependency-name: k8s.io/cluster-bootstrap
  dependency-version: 0.37.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: k8s-dependencies
- dependency-name: k8s.io/component-base
  dependency-version: 0.37.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: k8s-dependencies
- dependency-name: k8s.io/kubectl
  dependency-version: 0.37.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: k8s-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps the golang-org group with 7 updates:

| Package | From | To |
| --- | --- | --- |
| [golang.org/x/crypto](https://github.com/golang/crypto) | `0.58.0` | `0.59.0` |
| [golang.org/x/mod](https://github.com/golang/mod) | `0.42.0` | `0.43.0` |
| [golang.org/x/oauth2](https://github.com/golang/oauth2) | `0.37.0` | `0.38.0` |
| [golang.org/x/sync](https://github.com/golang/sync) | `0.24.0` | `0.25.0` |
| [golang.org/x/sys](https://github.com/golang/sys) | `0.49.0` | `0.50.0` |
| [golang.org/x/term](https://github.com/golang/term) | `0.47.0` | `0.48.0` |
| [golang.org/x/text](https://github.com/golang/text) | `0.43.0` | `0.44.0` |


Updates `golang.org/x/crypto` from 0.58.0 to 0.59.0
- [Commits](golang/crypto@v0.58.0...v0.59.0)

Updates `golang.org/x/mod` from 0.42.0 to 0.43.0
- [Commits](golang/mod@v0.42.0...v0.43.0)

Updates `golang.org/x/oauth2` from 0.37.0 to 0.38.0
- [Commits](golang/oauth2@v0.37.0...v0.38.0)

Updates `golang.org/x/sync` from 0.24.0 to 0.25.0
- [Commits](golang/sync@v0.24.0...v0.25.0)

Updates `golang.org/x/sys` from 0.49.0 to 0.50.0
- [Commits](golang/sys@v0.49.0...v0.50.0)

Updates `golang.org/x/term` from 0.47.0 to 0.48.0
- [Commits](golang/term@v0.47.0...v0.48.0)

Updates `golang.org/x/text` from 0.43.0 to 0.44.0
- [Release notes](https://github.com/golang/text/releases)
- [Commits](golang/text@v0.43.0...v0.44.0)

---
updated-dependencies:
- dependency-name: golang.org/x/crypto
  dependency-version: 0.59.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
- dependency-name: golang.org/x/mod
  dependency-version: 0.43.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
- dependency-name: golang.org/x/oauth2
  dependency-version: 0.38.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
- dependency-name: golang.org/x/sync
  dependency-version: 0.25.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
- dependency-name: golang.org/x/sys
  dependency-version: 0.50.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
- dependency-name: golang.org/x/term
  dependency-version: 0.48.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
- dependency-name: golang.org/x/text
  dependency-version: 0.44.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: golang-org
...

Signed-off-by: dependabot[bot] <support@github.com>
…ules/golang-org-2ce7ba5544

chore(deps): bump the golang-org group with 7 updates
…version-d000e6b

Kicbase/ISO: Update runc from v1.5.2 to v1.5.3
test.sh selects test packages with go list and runs go test without the
Makefile's libvirt_dlopen tag. On Linux/amd64 this compiles the libvirt
Go module in its default mode, which requires the libvirt development
headers and pkg-config files, breaking unit tests after those packages
were removed from CI.

Pass MINIKUBE_BUILD_TAGS from the Makefile test target and include it in
both go list and go test so unit tests use the same build configuration
as the minikube build.
golangci-lint and go vet do not use the Makefile build tags, so they
compile the libvirt Go module in its default mode, which requires the
libvirt development headers and pkg-config file. This mismatch is not
known to have caused lint or vet failures, but it leaves an unnecessary
build dependency.

Add libvirt_dlopen to the golangci-lint configurations and to the vet
target so these checks compile the same kvm driver configuration as the
build. With lint no longer requiring libvirt development packages, stop
installing libvirt-dev in the lint job.
Commit 7bc97d7 ("kvm: Convert to internal driver") made the kvm
driver an internal driver and started building minikube with the
libvirt_dlopen tag. In this mode the libvirt Go module does not include
the system libvirt headers or link against libvirt; it resolves the
libvirt symbols at runtime with dlopen.

The CI jobs still install libvirt-dev even though it is not needed for
building or unit tests. This also fails on systems where the package is
only available from an optional repository, such as CRB on Rocky Linux.

Remove the libvirt-dev installs from the build, unit test, translation,
and kicbase jobs, and remove the stale libvirt-dev requirement from the
testing guide.
The build pages require Go 1.22.0, but the bootstrap toolchain only needs
support for automatic toolchain downloads, which was added in Go 1.21.
The Makefile exports GOTOOLCHAIN from GO_VERSION, so an older Go
installation downloads and runs the pinned build toolchain.

Document Go 1.21.0 as the minimum and mention that the build downloads
the Go version specified by GO_VERSION automatically.
New contributors currently have to piece together the build dependencies
from the release build page, the testing page, CI workflows, and helper
scripts.

Add a setup section to the contributor guide covering Linux and macOS,
and point the binary build page directly to that section. The Linux
package lists do not include libvirt-devel because minikube builds with
the libvirt_dlopen tag and only needs the libvirt shared library at
runtime.

More work is needed to add the Windows section.

Refs: kubernetes#24058 (comment)
Signed-off-by: Hawon Cho <wonby1n@gmail.com>
…ules/k8s-dependencies-bce1ace115

chore(deps): bump the k8s-dependencies group with 6 updates
…version-a10d823

Kicbase/ISO: Update crun from 1.30.1 to 1.31
kicbase: Select the push token by repository
test: Add a functional test for minikube ssh-host
build: Drop libvirt-devel dependency and improve contributor docs
Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 8.1.2 to 8.1.3.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](peter-evans/create-pull-request@15733db...3ffccac)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-version: 8.1.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
…_actions/peter-evans/create-pull-request-8.1.3

chore(deps): bump peter-evans/create-pull-request from 8.1.2 to 8.1.3
…ment-setup

docs: Add Windows contributor setup
The version command builds its output from an ad-hoc map that mixes
collected data and formatting. That makes the formatting code difficult
to extract and test, and leaves no clear place to add the upcoming
kicbase and iso image lists.

Introduce versionInfo to hold the data the command collects: version,
commit, and component versions. The machine-readable representation
still uses map[string]interface{} because values will include []string
entries for kicbase and iso images, while most components remain
strings.

This is a mechanical refactor: command output and flag handling are
unchanged.
The version command formats output and exits directly from the command
logic, emitting lines through the out package as it goes. That keeps
formatting, output, and exit behavior entangled with data collection and
makes the formatting code hard to test.

Move formatting into formatVersion, which writes to a strings.Builder and
returns the complete output string. Before, output was emitted line by
line through out.Ln and the process exited on the first formatting error.
After, the formatter returns a versionError carrying the reason and
message, and the command writes the result with out.String and performs
the exit.

This is a mechanical extraction: command output and flag handling are
unchanged.
nirs added 8 commits November 22, 2026 03:38
The version formatter now takes controlled versionInfo data but has no
tests. Add golden-file coverage for the current behavior so the upcoming
text-format change can be reviewed as an intentional diff.

Cover default output, empty commit, components, --short, JSON, YAML,
short combined with JSON/YAML, components with JSON/YAML, and invalid
output. The goldens intentionally capture the current block component
format and the extra trailing newline after YAML; those remain separate
fixes.

Force LF for testdata text files so the fixtures work on Windows.
yaml.Marshal already terminates the document with a newline. The
formatter appended another newline, leaving a blank line after the YAML
output. This was preserved from the previous out.Ln call when formatting
was extracted.

Return the marshaled bytes unchanged and update the YAML testdata to
match.
The default text output used key: value for the first lines, but rendered
components with a blank line, a heading, and an unindented value on the
next line. That was not valid YAML for scalar values and looked broken
for single-line component versions.

Render sorted components as key: value lines with no blank separators and
update the testdata. JSON and YAML output are unchanged.
The default text formatter writes key/value lines manually. That works
for strings but would require special handling for the upcoming kicbase
and iso image lists.

Build an ordered yaml.MapSlice with the legacy key names and marshal it.
This keeps the current output unchanged and lets the YAML encoder render
future list fields in the standard block form.

For example, a future kicbase field is just another ordered item:

    ordered = append(ordered, yaml.MapItem{
        Key:   "kicbase",
        Value: info.Kicbase,
    })

and yaml.Marshal renders it as:

    kicbase:
    - image1
    - image2

without any list-specific formatting code.
The version command will report the built-in kicbase images. Add a
helper returning the primary image as a list so callers do not need to
change when additional registry fallbacks are published.

Only BaseImage is returned today. The fallback list stopped working when
kicbase builds moved to GitHub Actions: the workflow cannot push images
to gcr.io, so the gcr.io fallback is stale. DefaultImages exposes the
image minikube actually uses instead of advertising broken fallbacks.

When publishing moves to quay.io, restore the fallback and append it here.
Users debugging a failed kicbase pull need the exact built-in image
reference, but the version output does not include it. The image is also
about to become the default documented elsewhere, so expose it from the
version command.

Add Kicbase to versionInfo, populate it from kic.DefaultImages(), and
render it as an ordered list in text output and as an array in JSON/YAML.
The list entries are complete image references so they can be used
directly. Since the default text output is YAML, for example:

    podman pull "$(minikube version | yq '.kicbase[0]')"

Tests use a synthetic multi-image list with a fixed real digest so they
do not change with every kicbase build.
The version formatter now reports a generic "version failure" fallback
instead of the removed JSON/YAML failure strings. Regenerate translations
to keep strings.txt and locale files in sync.
pflag prints the `--base-image` default in `--help` and in the generated
command docs. The image digest changes with every kicbase build, so the
kicbase workflow had to run `make generate-docs` in a job with repository
secrets and write access.

Register `--base-image` with an empty default and supply the built-in
image through `viper.SetDefault`, preserving flag, env, and config
precedence.

Removing `make generate-docs` also eliminates the `Set up Go` step and
simplifies the manual recovery instructions when the bot fails to
7E2C
 push a
commit.

Since the help text no longer shows the image, add a hint pointing to
`minikube version`:

    % minikube start --help | grep -A1 base-image
        --base-image='':
            The base image to use for docker/podman drivers. Intended for local
            development. See "minikube version" for the default images.
@nirs nirs closed this Nov 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

0