Skip to content

Conversation

mstruebing
Copy link
Member

@mstruebing mstruebing commented Feb 10, 2025

The directory where to generate the docs from was wrong, I'm not sure
when this changed but probably during the move from release-0.x to
release-1.x.

Also the entryPointStrategy needed to be set so that we are able to
include these files to generate the docs even if our ts-config doesn't
include them.
This was the default behavior a couple of releases of typedoc ago but
was changed.

Closes #2209

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 10, 2025
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 10, 2025
@k8s-ci-robot k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Feb 10, 2025
@cjihrig
Copy link
Contributor

cjihrig commented Feb 10, 2025

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 10, 2025
@cjihrig
Copy link
Contributor

cjihrig commented Feb 10, 2025

FYI - the bot does not like the commit message.

The directory where to generate the docs from was wrong, I'm not sure
when this changed but probably during the move from release-0.x to
release-1.x.

Also the `entryPointStrategy` needed to be set so that we are able to
include these files to generate the docs even if our ts-config doesn't
include them.
This was the default behavior a couple of releases of typedoc ago but
was changed.
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. labels Feb 10, 2025
@mstruebing
Copy link
Member Author

@cjihrig thanks for the notification.
I've changed the commit message to remove the Closes #2209 part.

Copy link
Contributor

@cjihrig cjihrig 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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 10, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cjihrig, mstruebing

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 88735ae into main Feb 10, 2025
8 checks passed
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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cant generate docs via npm run docs - "The glob ./src/gen/api did not match any files"

3 participants