mirror of
https://github.com/openai/codex.git
synced 2026-10-28 18:58:46 +00:00
Dylan HurdandCodex
7dbe1c9498
## Summary Remove the deprecated `experimental_instructions_file` config setting from the typed config surface and the remaining deprecation-notice plumbing. `model_instructions_file` remains the supported setting and its loading path is unchanged. The setting was deprecated when it was renamed to `model_instructions_file` on January 20, 2026 in https://github.com/openai/codex/pull/9555. ## Changes - Remove `experimental_instructions_file` from `ConfigToml` and `ConfigProfile`. - Delete the custom config-layer scan and session deprecation notice for the removed setting. - Stop clearing the removed field from generated session config locks. - Remove the obsolete deprecation-notice test case while keeping `model_instructions_file` coverage intact. ## Validation - `just write-config-schema` - `just fmt` - `cargo test -p codex-config` - `cargo test -p codex-core model_instructions_file` - `just fix -p codex-core` - `git diff --check` Co-authored-by: Codex <noreply@openai.com>
98 lines
4.1 KiB
Rust
98 lines
4.1 KiB
Rust
use codex_utils_absolute_path::AbsolutePathBuf;
|
|
use schemars::JsonSchema;
|
|
use serde::Deserialize;
|
|
use serde::Serialize;
|
|
|
|
use crate::config_toml::ToolsToml;
|
|
use crate::types::AnalyticsConfigToml;
|
|
use crate::types::ApprovalsReviewer;
|
|
use crate::types::Personality;
|
|
use crate::types::SessionPickerViewMode;
|
|
use crate::types::WindowsToml;
|
|
use codex_features::FeaturesToml;
|
|
use codex_protocol::config_types::ReasoningSummary;
|
|
use codex_protocol::config_types::SandboxMode;
|
|
use codex_protocol::config_types::Verbosity;
|
|
use codex_protocol::config_types::WebSearchMode;
|
|
use codex_protocol::openai_models::ReasoningEffort;
|
|
use codex_protocol::protocol::AskForApproval;
|
|
|
|
/// Collection of common configuration options that a user can define as a unit
|
|
/// in `config.toml`.
|
|
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
|
|
#[schemars(deny_unknown_fields)]
|
|
pub struct ConfigProfile {
|
|
pub model: Option<String>,
|
|
/// Optional explicit service tier request id for new turns (for example
|
|
/// `priority` or `flex`; legacy `fast` also works).
|
|
pub service_tier: Option<String>,
|
|
/// The key in the `model_providers` map identifying the
|
|
/// [`ModelProviderInfo`] to use.
|
|
pub model_provider: Option<String>,
|
|
pub approval_policy: Option<AskForApproval>,
|
|
pub approvals_reviewer: Option<ApprovalsReviewer>,
|
|
pub sandbox_mode: Option<SandboxMode>,
|
|
pub model_reasoning_effort: Option<ReasoningEffort>,
|
|
pub plan_mode_reasoning_effort: Option<ReasoningEffort>,
|
|
pub model_reasoning_summary: Option<ReasoningSummary>,
|
|
pub model_verbosity: Option<Verbosity>,
|
|
/// Optional path to a JSON model catalog (applied on startup only).
|
|
pub model_catalog_json: Option<AbsolutePathBuf>,
|
|
pub personality: Option<Personality>,
|
|
pub chatgpt_base_url: Option<String>,
|
|
/// Optional path to a file containing model instructions.
|
|
pub model_instructions_file: Option<AbsolutePathBuf>,
|
|
/// Deprecated: ignored.
|
|
#[schemars(skip)]
|
|
pub js_repl_node_path: Option<AbsolutePathBuf>,
|
|
/// Deprecated: ignored.
|
|
#[schemars(skip)]
|
|
pub js_repl_node_module_dirs: Option<Vec<AbsolutePathBuf>>,
|
|
/// Optional absolute path to patched zsh used by zsh-exec-bridge-backed shell execution.
|
|
pub zsh_path: Option<AbsolutePathBuf>,
|
|
pub experimental_compact_prompt_file: Option<AbsolutePathBuf>,
|
|
pub include_permissions_instructions: Option<bool>,
|
|
pub include_apps_instructions: Option<bool>,
|
|
pub include_collaboration_mode_instructions: Option<bool>,
|
|
pub include_environment_context: Option<bool>,
|
|
pub experimental_use_unified_exec_tool: Option<bool>,
|
|
pub tools: Option<ToolsToml>,
|
|
pub web_search: Option<WebSearchMode>,
|
|
pub analytics: Option<AnalyticsConfigToml>,
|
|
/// TUI settings scoped to this profile.
|
|
#[serde(default)]
|
|
pub tui: Option<ProfileTui>,
|
|
#[serde(default)]
|
|
pub windows: Option<WindowsToml>,
|
|
/// Optional feature toggles scoped to this profile.
|
|
#[serde(default)]
|
|
// Injects known feature keys into the schema and forbids unknown keys.
|
|
#[schemars(schema_with = "crate::schema::features_schema")]
|
|
pub features: Option<FeaturesToml>,
|
|
pub oss_provider: Option<String>,
|
|
}
|
|
|
|
/// TUI settings supported inside a named profile.
|
|
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
|
|
#[serde(deny_unknown_fields)]
|
|
#[schemars(deny_unknown_fields)]
|
|
pub struct ProfileTui {
|
|
/// Preferred layout for resume/fork session picker results.
|
|
#[serde(default)]
|
|
pub session_picker_view: Option<SessionPickerViewMode>,
|
|
}
|
|
|
|
impl From<ConfigProfile> for codex_app_server_protocol::Profile {
|
|
fn from(config_profile: ConfigProfile) -> Self {
|
|
Self {
|
|
model: config_profile.model,
|
|
model_provider: config_profile.model_provider,
|
|
approval_policy: config_profile.approval_policy,
|
|
model_reasoning_effort: config_profile.model_reasoning_effort,
|
|
model_reasoning_summary: config_profile.model_reasoning_summary,
|
|
model_verbosity: config_profile.model_verbosity,
|
|
chatgpt_base_url: config_profile.chatgpt_base_url,
|
|
}
|
|
}
|
|
}
|