Skip to content

Auto generate Helm docs#6639

Merged
jetstack-bot merged 4 commits intocert-manager:masterfrom
ThatsMrTalbot:feat/auto-generate-helm-docs
Jan 16, 2024
Merged

Auto generate Helm docs#6639
jetstack-bot merged 4 commits intocert-manager:masterfrom
ThatsMrTalbot:feat/auto-generate-helm-docs

Conversation

@ThatsMrTalbot
Copy link
Copy Markdown
Contributor

@ThatsMrTalbot ThatsMrTalbot commented Jan 15, 2024

Pull Request Motivation

In order to avoid missing docs we can autogenerate the README from the values.yaml, this PR adds comments to all values in the values.yaml file and adds automation to update the chart README in place

Updated README can be previewed here:
https://github.com/ThatsMrTalbot/cert-manager/blob/feat/auto-generate-helm-docs/deploy/charts/cert-manager/README.template.md

Kind

Release Note

NONE

Signed-off-by: Adam Talbot <adam.talbot@venafi.com>
@jetstack-bot jetstack-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/deploy Indicates a PR modifies deployment configuration labels Jan 15, 2024
Signed-off-by: Adam Talbot <adam.talbot@venafi.com>
@ThatsMrTalbot ThatsMrTalbot force-pushed the feat/auto-generate-helm-docs branch from 9403914 to af4685c Compare January 15, 2024 10:25
Signed-off-by: Adam Talbot <adam.talbot@venafi.com>
@ThatsMrTalbot ThatsMrTalbot force-pushed the feat/auto-generate-helm-docs branch from e81fbc5 to e8987bc Compare January 15, 2024 10:30
Signed-off-by: Adam Talbot <adam.talbot@venafi.com>
@inteon
Copy link
Copy Markdown
Member

inteon commented Jan 16, 2024

LGTM
/approve
/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 16, 2024
@jetstack-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon

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

@jetstack-bot jetstack-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 16, 2024
@jetstack-bot jetstack-bot merged commit 93bbb35 into cert-manager:master Jan 16, 2024
@wallrj
Copy link
Copy Markdown
Member

wallrj commented Jan 31, 2024

SgtCoDFish added a commit to SgtCoDFish/cert-manager that referenced this pull request Jan 31, 2024
See cert-manager#6639

This was discovered during the release of cert-manager v1.14.0. See the
summary on Slack:

https://kubernetes.slack.com/archives/CDEQJ0Q8M/p1706723744656039?thread_ts=1706713005.073879&cid=CDEQJ0Q8M

Signed-off-by: Ashley Davis <ashley.davis@venafi.com>
jetstack-bot pushed a commit to jetstack-bot/cert-manager that referenced this pull request Jan 31, 2024
See cert-manager#6639

This was discovered during the release of cert-manager v1.14.0. See the
summary on Slack:

https://kubernetes.slack.com/archives/CDEQJ0Q8M/p1706723744656039?thread_ts=1706713005.073879&cid=CDEQJ0Q8M

Signed-off-by: Ashley Davis <ashley.davis@venafi.com>
logand22 pushed a commit to gravitational/cert-manager that referenced this pull request Mar 8, 2024
See cert-manager#6639

This was discovered during the release of cert-manager v1.14.0. See the
summary on Slack:

https://kubernetes.slack.com/archives/CDEQJ0Q8M/p1706723744656039?thread_ts=1706713005.073879&cid=CDEQJ0Q8M

Signed-off-by: Ashley Davis <ashley.davis@venafi.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/deploy Indicates a PR modifies deployment configuration 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. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants