Skip to content

docs(source): autogenerate docs for events#6119

Merged
k8s-ci-robot merged 8 commits intokubernetes-sigs:masterfrom
gofogo:docs-source-autogenerate-docs-events
Jan 21, 2026
Merged

docs(source): autogenerate docs for events#6119
k8s-ci-robot merged 8 commits intokubernetes-sigs:masterfrom
gofogo:docs-source-autogenerate-docs-events

Conversation

@ivankatliarchuk
Copy link
Copy Markdown
Member

@ivankatliarchuk ivankatliarchuk commented Jan 16, 2026

What does it do ?

Autogenerate docs for sources that do or do not support events. Added few example annotations.

Follow-up PR https://github.com/kubernetes-sigs/external-dns/pull/6099/changes#diff-11a48066892ef7176ddc61b21bcc6b421a62c745702e8b8a3948cf456daf8362

Motivation

Autogenerate docs for sources

More

  • Yes, this PR title follows Conventional Commits
  • Yes, I added unit tests
  • Yes, I updated end user documentation accordingly

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk ivankatliarchuk marked this pull request as draft January 16, 2026 10:50
@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. internal Issues or PRs related to internal code labels Jan 16, 2026
@k8s-ci-robot k8s-ci-robot requested review from szuecs and vflaux January 16, 2026 10:50
@k8s-ci-robot k8s-ci-robot added source cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 16, 2026
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added docs size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 16, 2026
@coveralls
Copy link
Copy Markdown

coveralls commented Jan 16, 2026

Pull Request Test Coverage Report for Build 21206677659

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 89 unchanged lines in 8 files lost coverage.
  • Overall coverage decreased (-0.06%) to 79.01%

Files with Coverage Reduction New Missed Lines %
fake.go 1 96.23%
openshift_route.go 1 84.78%
zonefinder.go 3 90.0%
controller.go 9 92.56%
crd.go 10 66.45%
ambassador_host.go 13 82.67%
gen/docs/sources/main.go 13 81.7%
ovh/ovh.go 39 91.75%
Totals Coverage Status
Change from base Build 21060483362: -0.06%
Covered Lines: 16058
Relevant Lines: 20324

💛 - Coveralls

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 16, 2026
@ivankatliarchuk ivankatliarchuk marked this pull request as ready for review January 16, 2026 11:08
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 16, 2026
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 16, 2026
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk ivankatliarchuk force-pushed the docs-source-autogenerate-docs-events branch from 54b559f to 2ecead1 Compare January 16, 2026 11:22
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
// +externaldns:source:filters=
// +externaldns:source:namespace=all,single
// +externaldns:source:fqdn-template=false
// +externaldns:source:events=false|true
Copy link
Copy Markdown
Contributor

@vflaux vflaux Jan 20, 2026

Choose a reason for hiding this comment

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

Could you also add this in the Annotation Reference section?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Added. Will think of how to make sure docs and code is in sync for this section

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@vflaux
Copy link
Copy Markdown
Contributor

vflaux commented Jan 21, 2026

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 21, 2026
@ivankatliarchuk
Copy link
Copy Markdown
Member Author

/approve

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 21, 2026
@k8s-ci-robot k8s-ci-robot merged commit a174cc0 into kubernetes-sigs:master Jan 21, 2026
18 checks passed
@ivankatliarchuk ivankatliarchuk deleted the docs-source-autogenerate-docs-events branch January 21, 2026 11:07
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. docs internal Issues or PRs related to internal code lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants