Define the Crossplane CLI maintenance and docs retention policy
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 領域
- documentation, release
調査の方向性
既存の core リリースサイクルのページと docs.crossplane.io/cli/ 領域から始め、crossplane/crossplane#7350 と参照されている docs PR の履歴を読んでください。完了条件は、合意された CLI のサポートおよびバックポート期間、以前のリリースを対象とする保持ルール、公開された CLI-to-core 互換性マトリクスが整い、core リリースドキュメントからポリシーにリンクされていることです。
索引モデルが issue の本文から書いたものです。
説明
What problem are you facing?
The CLI has no documented maintenance policy. Core Crossplane has one (https://docs.crossplane.io/latest/learn/release-cycle/ quarterly cadence, three most recent minors maintained, roughly nine months per release), but nothing on that page or anywhere else covers the CLI specifically.
This surfaced concretely in a docs PR removing the CLI v2.2 release notes page. Two defensible positions, no rule to decide between them:
- Core v2.2 is still maintained and the v2.2 CLI shipped as part of it, so the docs should stay until core v2.2 is EOL.
- The CLI is now versioned and released independently of core (crossplane/crossplane#7350), so core's support window is the wrong anchor. If we release CLI v2.6 tomorrow with no core release attached, the first rule produces no answer.
crossplane/crossplane#7350 partially covers this: it states that CLI minors are cut for substantial changes and alongside each core minor, and that only the two most recent CLI minors are supported. That PR is still open, lives in c/c rather than here, and addresses CLI-to-core compatibility rather than which CLI versions we maintain and document.
How could Crossplane help solve your problem?
Land an explicit policy and publish it in the docs. Specifically:
1. CLI support window. How many CLI minor versions are maintained, or over what period? Options: two most recent CLI minors (per #7350), three to mirror core, or a time-based window (nine months, as core effectively provides). Whichever we pick needs to hold when the CLI releases off core's cadence.
2. Patch and backport policy. Which CLI branches receive backports, and under what criteria. Core's "eligible for backporting to any maintained release branch" is a reasonable starting point.
3. Docs retention rule. Which CLI versions keep a docs entry. Proposal: retention follows the CLI support window, with a transitional carve-out for CLI versions that shipped inside core (v2.3 and earlier) those stay until their corresponding core version is EOL. That resolves the v2.2 case without tying future retention to core's cadence.
4. Compatibility matrix. A published table of CLI version to supported core versions, derived from the rules in #7350. Today users have to read a design doc to work this out.
5. Where the policy lives. Either a section on the existing core release cycle page or a dedicated CLI page under docs.crossplane.io/cli/. The core page is where people will look first, so a CLI section there with a link to fuller detail probably works best.
- crossplane/crossplane#7350 — CLI versioning and release one-pager
- crossplane/crossplane#4850 — CLI separate repository / release cadence
- crossplane/docs#1138 — removal of CLI v2.1 docs during the v2.4 release
- 主要言語
- 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時間未満 初心者へのやさしさ 90/100
-
Bob Shell support オープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
santhosh-tekuri/jsonschema#276 ·