Skip to content

Update generated reference documentation for cert-manager v1.18.0#1710

Merged
cert-manager-prow[bot] merged 3 commits intocert-manager:release-nextfrom
wallrj:reference-1.18.0
Jun 10, 2025
Merged

Update generated reference documentation for cert-manager v1.18.0#1710
cert-manager-prow[bot] merged 3 commits intocert-manager:release-nextfrom
wallrj:reference-1.18.0

Conversation

@wallrj
Copy link
Copy Markdown
Member

@wallrj wallrj commented Jun 10, 2025 •
edited
Loading

Preview:

In preparation for releasing cert-manager v1.18.0 (#1708), I updated the versions in scripts/gendocs/generate-new-import-path-docs and then ran:

$ ./scripts/gendocs/generate
...
+++ Creating temporary GOPATH
go: downloading github.com/ahmetb/gen-crd-api-reference-docs v0.3.0
go: downloading github.com/pkg/errors v0.8.1
go: downloading k8s.io/klog v0.2.0
go: downloading k8s.io/gengo v0.0.0-20201203183100-97869a43a9d9
go: downloading github.com/russross/blackfriday/v2 v2.0.1
go: downloading github.com/shurcooL/sanitized_anchor_name v1.0.0
go: downloading k8s.io/klog/v2 v2.2.0
go: downloading github.com/go-logr/logr v0.2.0
+++ Cloning cert-manager repository...
Cloning into '/tmp/tmp.jepChl3SHq/go/src/github.com/cert-manager/cert-manager'...
remote: Enumerating objects: 1462, done.
remote: Counting objects: 100% (1462/1462), done.
remote: Compressing objects: 100% (1130/1130), done.
remote: Total 1462 (delta 379), reused 772 (delta 209), pack-reused 0 (from 0)
Receiving objects: 100% (1462/1462), 3.05 MiB | 9.49 MiB/s, done.
Resolving deltas: 100% (379/379), done.
+++ Running 'go mod vendor'
go work init
+++ Generating reference docs...
I0610 09:35:55.514682  616355 main.go:129] parsing go packages in directory ./pkg/apis
I0610 09:36:35.609117  616355 main.go:231] using package=github.com/cert-manager/cert-manager/pkg/apis/acme/v1
I0610 09:36:35.609164  616355 main.go:231] using package=github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1
I0610 09:36:35.609167  616355 main.go:231] using package=github.com/cert-manager/cert-manager/pkg/apis/config/cainjector/v1alpha1
I0610 09:36:35.609169  616355 main.go:231] using package=github.com/cert-manager/cert-manager/pkg/apis/config/controller/v1alpha1
I0610 09:36:35.609171  616355 main.go:231] using package=github.com/cert-manager/cert-manager/pkg/apis/config/webhook/v1alpha1
I0610 09:36:35.609173  616355 main.go:231] using package=github.com/cert-manager/cert-manager/pkg/apis/meta/v1
W0610 09:36:35.616744  616355 main.go:442] not found external link source for type sigs.k8s.io/gateway-api/apis/v1.ParentReference
W0610 09:36:35.628327  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.LeaderElectionConfig
W0610 09:36:35.628552  616355 main.go:442] not found external link source for type k8s.io/component-base/logs/api/v1.LoggingConfiguration
W0610 09:36:35.629770  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig
W0610 09:36:35.652999  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.Duration
W0610 09:36:35.654920  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig
W0610 09:36:35.655520  616355 main.go:442] not found external link source for type k8s.io/component-base/logs/api/v1.LoggingConfiguration
W0610 09:36:35.656299  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.LeaderElectionConfig
W0610 09:36:35.656479  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.Duration
W0610 09:36:35.658535  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig
W0610 09:36:35.658819  616355 main.go:442] not found external link source for type k8s.io/component-base/logs/api/v1.LoggingConfiguration
W0610 09:36:35.659114  616355 main.go:442] not found external link source for type github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig
I0610 09:36:35.675533  616355 main.go:167] written to /tmp/tmp.JLqk4ifRaS/docs/api-docs.md
+++ Generating CLI reference docs for cmd/acmesolver ...
+++ Generating CLI reference docs for cmd/cainjector ...
+++ target cmd/ctl does not exist, skipping...
+++ Generating CLI reference docs for cmd/controller ...
+++ Generating CLI reference docs for cmd/webhook ...
+++ Generating CLI reference docs for cmd/startupapicheck ...
cp: '/home/richard/projects/cert-manager/website/content/docs/cli' and '/home/richard/projects/cert-manager/website/content/docs/cli' are the same file
+++ Cleaning up temporary GOPATH

@wallrj-cyberark
Update version for CLI reference docs
06c9406 
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
@wallrj-cyberark
./scripts/gendocs/generate
a2cb2f5 
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 10, 2025
@wallrj wallrj requested a review from Copilot June 10, 2025 08:42

This comment was marked as outdated.

Sign in to view

@wallrj wallrj requested a review from Copilot June 10, 2025 08:43
@netlify
Copy link
Copy Markdown

netlify bot commented Jun 10, 2025 •
edited
Loading

✅ Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4757f5d
🔍 Latest deploy log https://app.netlify.com/projects/cert-manager/deploys/6847fbc3739b10000872b0c4
😎 Deploy Preview https://deploy-preview-1710--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI reviewed Jun 10, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the generated API and CLI reference documentation for cert-manager v1.18.0, including grammar fixes, new fields, and updated defaults to align with the v1.18.0 codebase.

  • Update the generate-new-import-path-docs script for v1.18 docs generation
  • Revise API docs (api-docs.md) with new fields (profile, signatureAlgorithm), grammar tweaks, and default value updates
  • Extend CLI reference docs (webhook.md, controller.md, cainjector.md) with additional feature-gates and flags

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
scripts/gendocs/generate-new-import-path-docs Enable docs generation for v1.18 and comment out v1.17 generation
content/docs/reference/api-docs.md Add new fields, fix grammar, update defaults, and add SignatureAlgorithm enum
content/docs/cli/webhook.md Add new feature-gate flags under --feature-gates
content/docs/cli/controller.md Expand controllers list, add --extra-certificate-annotations, new feature-gate flags
content/docs/cli/cainjector.md Minor formatting indentation fix
Comments suppressed due to low confidence (1)

content/docs/reference/api-docs.md:6235

  • The default Venafi Cloud base URL now omits the '/v1' path present previously. Confirm whether the default should still include '/v1' to match the API version endpoint.
<p> URL is the base URL for Venafi Cloud. Defaults to “<a href='https://api.venafi.cloud/'>https://api.venafi.cloud/”</a>. </p>

@wallrj wallrj mentioned this pull request Jun 10, 2025
Merged
wallrj
wallrj commented Jun 10, 2025
View reviewed changes
content/docs/reference/api-docs.md
<td>
<em>(Optional)</em>
<p> URL is the base URL for Venafi Cloud. Defaults to &ldquo;<a href='https://api.venafi.cloud/v1"'>https://api.venafi.cloud/v1&rdquo;</a>. </p>
<p> URL is the base URL for Venafi Cloud. Defaults to &ldquo;<a href='https://api.venafi.cloud/"'>https://api.venafi.cloud/&rdquo;</a>. </p>
Copy link
Copy Markdown
Member Author

@wallrj wallrj Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wallrj
Apply suggestions from code review
4757f5d 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Richard Wall <wallrj@users.noreply.github.com>
@wallrj wallrj requested a review from erikgb June 10, 2025 09:46
erikgb
erikgb reviewed Jun 10, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@erikgb erikgb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@cert-manager-prow cert-manager-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jun 10, 2025
@cert-manager-prow
Copy link
Copy Markdown
Contributor

cert-manager-prow bot commented Jun 10, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: erikgb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@cert-manager-prow cert-manager-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 10, 2025
@cert-manager-prow cert-manager-prow bot merged commit d3d777d into cert-manager:release-next Jun 10, 2025
7 checks passed
@wallrj wallrj mentioned this pull request Jun 10, 2025
Merged
11 tasks
@wallrj wallrj deleted the reference-1.18.0 branch June 10, 2025 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erikgb erikgb erikgb left review comments

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@wallrj @erikgb @wallrj-cyberark