Skip to content

'get docs' command#1262

Merged
kohsuke merged 7 commits intomainfrom
get-docs
Mar 27, 2026
Merged

'get docs' command#1262
kohsuke merged 7 commits intomainfrom
get-docs

Conversation

@kohsuke
Copy link
Copy Markdown
Contributor

@kohsuke kohsuke commented Mar 19, 2026

I added a command to retrieve product documentation in the asciidocs format to the current directory.

This is a prerequisite for the AI agent skill that references product documentation

kohsuke added 4 commits March 19, 2026 18:37
I believe large-runners are IP whitelisted
Trying to access the docs repo from the build is running into all sorts
of problems. This repo is in cloudbees-oss, and docs is not, and there
are various security measures in place.

Duplicating docs isn't great, but it gets us to the value quickly
instead of getting bogged down to details.
# Run via: uv run poe update-docs
set -euo pipefail

REPO="git@github.com:cloudbees/docsite-cloudbees-smart-tests.git"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I’d like to update the documents automatically using something like a cron in Github Actions, but since his repo is private it seems difficult

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Exactly. I should have left this in comment somewhere -- I spent hours trying to do this as a part of the build process, but in the end I couldn't work around the IP restriction to access this Git repo.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It's probably easier to do it as a push. Create a workflow in the internal repo, which deposits the doc bundle into this repo.

@args4p.command(help="Copy product documentation into ./smart-tests-docs")
def docs(app: Application):
output = Path(OUTPUT_DIR)
if output.exists():
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nits: I don't have a strong opinion on this part, but why do executors remove docs directory. Cannot we just overwrite it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It's because files might be removed.

@kohsuke kohsuke merged commit 1135650 into main Mar 27, 2026
2 checks passed
@kohsuke kohsuke deleted the get-docs branch March 27, 2026 03:00
@github-actions github-actions bot mentioned this pull request Mar 27, 2026
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

Successfully merging this pull request may close these issues.

2 participants