Org policy file: devready check --policy FILE

オープン
  • 何か問題がありますか？
#44 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
cli, devtools

調査の方向性

Start with section 6 of docs/plans/features-5-8.md and the existing check_tool version checks and _compare logic; the issue recommends beginning after #43. The plan spans policy loading and validation, evaluation, CLI and environment options, GitHub Action support, starter file generation, and documentation. Follow its one PR per step sequence; done means the stated policy results and exit behavior work, invalid content produces one policy.file ERROR without echoing contents, and organization guidance is documented.

索引モデルが issue の本文から書いたものです。

説明

enhancement

Problem: Platform teams want one minimum toolchain for every repo ("Git >= 2.40, Node >= 20, Docker required") without editing each repo's .devready.json, whose keys are frozen in 1.x.

Do: follow section 6 of the team features plan. One PR per step:

  • checks/policy.py: loader and validator, with hostile-content tests (file content is never echoed).
  • Requirement evaluation reusing check_tool versions and _compare; policy.* ids, explain.py entries, docs/checks.md rows.
  • --policy FILE flag and DEVREADY_POLICY env var; works with --recursive (#43), applying to every package.
  • GitHub Action policy input; devready init --policy prints a starter file.
  • Docs: a "Using DevReady across an organization" guide.

Policy file shape (unknown keys make the file invalid, reported as one ERROR result):

{"policy_version": 1,
 "require": {"node": ">=20", "python": ">=3.11", "git": ">=2.40", "docker": "*"},
 "skip": ["platform.autocrlf"],
 "env": ["NPM_TOKEN"]}

Done when:

  • devready check --policy org.json reports policy.<tool>.require results, and a policy fail exits 1.
  • A repo's .devready.json skip cannot skip policy.* ids.
  • An invalid policy file gives one policy.file ERROR and never prints its contents.

Notes:

  • Local files only. Remote URLs stay out (network checks need a design review first, see ROADMAP.md); teams vendor the file or fetch it in CI.
  • DEVREADY_POLICY holds a path; its value is never printed.
  • Best started after #43.
主要言語
Python
スター
2
フォーク
3
平均マージ
10時間 51分
マージ済み PR（30日）
40

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Evalogical-Inc/devReady のほかの issue

Evalogical-Inc/devReady の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。