Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build and Deploy Docs is broken #2023

Closed
clayrosenthal opened this issue Nov 12, 2024 · 2 comments
Closed

Build and Deploy Docs is broken #2023

clayrosenthal opened this issue Nov 12, 2024 · 2 comments

Comments

@clayrosenthal
Copy link

clayrosenthal commented Nov 12, 2024

Describe the bug
The build and deploy docs action appears to have been broken for about a year.

** Client Version **
0.22.2

** Server Version **
N/A

To Reproduce
Steps to reproduce the behavior:

  1. Run the github action
  2. Action fails

Expected behavior
Docs to be generated and published.

** Example Code**
Your workflow

Environment (please complete the following information):

  • OS: ubuntu
  • NodeJS Version 20
  • Cloud runtime Github Action runner

Additional context
I want to read the docs and was bummed they aren't updated anymore.

Appears in the action repo there is a fix by adding write permissions:

permissions:
  contents: write
@brendandburns
Copy link
Contributor

fwiw, these docs aren't that good, since they are generated from the generated APIs. You're better off reading https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/

Closing, since the PR merged.

@passcod
Copy link

passcod commented Jan 9, 2025

I am not in fact "better off" when I'm trying to find API information specific to these Typescript bindings and not the k8s API in general, and the linked PR merged with comments specifically saying "it is still not working" due to the CLA thing blocking the build.

At this point the docs are two years out of date. If you're not going to fix them, maybe remove the link from the readme?

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

No branches or pull requests

3 participants