Automatically update the command reference docs from CI
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- github-actions, go
- Domain
- ci-cd, documentation, release
Research direction
Review the CLI repository's existing CI configuration and the docs repository's content/master/ and release directories first. Trace how CLI reference documentation is generated, then use create-pull-request to automate updates after help changes and releases. Done means both update paths create usable pull requests in the appropriate docs directory.
Written by the indexing model from the issue text.
Description
What problem are you facing?
We're now able to auto-generate the CLI reference documentation for docs.crossplane.io, but have to do it manually.
How could Crossplane help solve your problem?
We should add CI jobs to:
- Update the CLI docs in the
content/master/directory of the docs repo every time we merge a help change to main. - Update the CLI docs in the relevant release directory of the docs repo (e.g.,
content/v2.3) every time we do a release.
We can use https://github.com/peter-evans/create-pull-request to automatically create PRs to the docs repo.
- Dominant language
- Go
- Stars
- 19
- Forks
- 31
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 53
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from crossplane/cli
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
crossplane/cli#282 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
crossplane/cli#384 ·
-
crossplane/cli#379 · 1 assignee ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 68/100
crossplane/cli#370 · 1 reaction ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 28/100
crossplane/cli#369 ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 60/100
github/gh-aw-mcpg#13748 ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
googleapis/librarian#7670 · 2 comments ·