[Bug]: Local config override file name differs between the docs (`<id>-config.local.yml`) and ConfigManager (`local-config.yml`)

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

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

@gavenren がすでに取り組んでいます。

2026年10月28日 から。

  • #5159 @gavenren による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
cli

調査の方向性

src/specify_cli/extensions/__init__.py の ConfigManager._get_local_config を読み、期待されるファイル名をユーザー向け、API、開発者向けの各ガイド、および src/specify_cli/shared_infra.py の ignore パターンと照らし合わせます。issue の再現スクリプトを使って該当するファイル名を確認してください。選んだ名前に、設定の上書き、hook の条件、Git の ignore 動作、関連する削除または復元処理が一致すれば完了です。

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

説明

triage-must-have
Bug Description

The user-facing extension docs tell users to put local overrides in .specify/extensions/<id>/<id>-config.local.yml. ConfigManager._get_local_config reads .specify/extensions/<id>/local-config.yml instead (src/specify_cli/extensions/__init__.py:5350). A user who follows the guide gets no override, both in get_config() and in hook conditions such as config.x is set. The shared .specify/.gitignore only covers extensions/*/local-config.yml (src/specify_cli/shared_infra.py:33), so the documented file is also not ignored by git, although the guide says it is.

Either side could be the one to change. The code, design/extension.md:146 and shared_infra.py:33 use local-config.yml. These say <id>-config.local.yml:

  • extensions/EXTENSION-USER-GUIDE.md:351,361,377,910
  • extensions/EXTENSION-API-REFERENCE.md:565,887
  • extensions/EXTENSION-DEVELOPMENT-GUIDE.md:388

The remove, backup and rescue code also preserves *-config.local.yml (for example __init__.py:3523-3549).

Steps to Reproduce

Save this as repro.py and run uv run python -I repro.py from the repository root.

import os, tempfile
from pathlib import Path
from specify_cli.extensions import ConfigManager

proj = Path(tempfile.mkdtemp())
d = proj / ".specify/extensions/jira"
d.mkdir(parents=True)
(d / "jira-config.yml").write_text('project:\n  key: "MSATS"\n')
(d / "jira-config.local.yml").write_text('project:\n  key: "MYTEST"\n')
os.environ.pop("SPECKIT_JIRA_PROJECT_KEY", None)
print("with jira-config.local.yml: project.key =", ConfigManager(proj, "jira").get_value("project.key"))
(d / "jira-config.local.yml").rename(d / "local-config.yml")
print("with local-config.yml:      project.key =", ConfigManager(proj, "jira").get_value("project.key"))
Expected Behavior

Per extensions/EXTENSION-USER-GUIDE.md:359-383, jira-config.local.yml overrides jira-config.yml, so project.key is MYTEST. If local-config.yml is the intended name, the user guide, API reference and development guide should say so.

Actual Behavior
with jira-config.local.yml: project.key = MSATS
with local-config.yml:      project.key = MYTEST
Specify CLI Version

1.2.4.dev0 (main at 27d14e2)

AI Agent

Not applicable

Operating System

Linux 6.18 (Ubuntu container)

Python Version

Python 3.12.3

Additional Context

The docstring of ConfigManager itself (__init__.py:5267) names local-config.yml, so the code is at least consistent with itself and with the design document.

Also reproduced on macOS (Darwin 25.6, arm64) with Python 3.14.4 and uv run python -I repro.py against 27d14e2; the output matches the above.

AI Disclosure

Found and reproduced with Claude Code (model: Claude Opus 4.8), run autonomously under human supervision. The human reporter re-ran every reproduction above before filing.

主要言語
Python
スター
144k
フォーク
12.9k
平均マージ
1日 6時間
マージ済み PR（30日）
194

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

github/spec-kit のほかの issue

github/spec-kit の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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