Automatically update the command reference docs from CI
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- github-actions, go
- 領域
- ci-cd, documentation, release
調査の方向性
まず、CLI リポジトリの既存の CI 設定と、ドキュメントリポジトリの content/master/ および release ディレクトリを確認します。CLI リファレンスドキュメントがどのように生成されるかを追跡し、その後 create-pull-request を使用して、help の変更とリリース後の更新を自動化します。両方の更新パスが適切なドキュメントディレクトリに利用可能な pull requests を作成すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Go
- スター
- 19
- フォーク
- 31
- 平均マージ
- 2日 15時間
- マージ済み PR（30日）
- 53
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
crossplane/cli のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
crossplane/cli#282 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
crossplane/cli#384 ·
-
crossplane/cli#379 · 担当者 1 名 ·
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
crossplane/cli#370 · リアクション 1 件 ·
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 28/100
crossplane/cli#369 ·
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 60/100
github/gh-aw-mcpg#13748 ·
-
agentic-workflows
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
googleapis/librarian#7670 · コメント 2 件 ·