mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
Document Codex git commit attribution config (#21379)
## Summary - document that commit attribution for generated git commit messages is gated by the `codex_git_commit` feature flag - add an example `config.toml` snippet showing `commit_attribution` with `[features].codex_git_commit = true` - update the config schema description so the reference docs explain that `commit_attribution` only takes effect when the feature is enabled Fixes #19799. ## Validation - `cargo run -p codex-core --bin codex-write-config-schema` - `cargo test -p codex-config` - `cargo test -p codex-features` - `cargo fmt --check` - `git diff --check` ## Notes - `cargo test -p codex-core config_schema_matches_fixture` currently fails before reaching the schema test because `core_test_support` imports `similar` without a linked crate in this checkout. The narrower package checks above avoid that unrelated test-support build failure.
This commit is contained in:
committed by
GitHub
Unverified
parent
123e78b97b
commit
8f5d68f9d2
@@ -176,7 +176,10 @@ pub struct ConfigToml {
|
||||
pub compact_prompt: Option<String>,
|
||||
|
||||
/// Optional commit attribution text for commit message co-author trailers.
|
||||
/// This top-level setting only takes effect when `[features].codex_git_commit`
|
||||
/// is enabled.
|
||||
///
|
||||
/// When enabled and unset, Codex uses `Codex <noreply@openai.com>`.
|
||||
/// Set to an empty string to disable automatic commit attribution.
|
||||
pub commit_attribution: Option<String>,
|
||||
|
||||
|
||||
@@ -3838,7 +3838,7 @@
|
||||
"description": "Preferred backend for storing CLI auth credentials. file (default): Use a file in the Codex home directory. keyring: Use an OS-specific keyring service. auto: Use the keyring if available, otherwise use a file."
|
||||
},
|
||||
"commit_attribution": {
|
||||
"description": "Optional commit attribution text for commit message co-author trailers.\n\nSet to an empty string to disable automatic commit attribution.",
|
||||
"description": "Optional commit attribution text for commit message co-author trailers. This top-level setting only takes effect when `[features].codex_git_commit` is enabled.\n\nWhen enabled and unset, Codex uses `Codex <noreply@openai.com>`. Set to an empty string to disable automatic commit attribution.",
|
||||
"type": "string"
|
||||
},
|
||||
"compact_prompt": {
|
||||
|
||||
@@ -476,6 +476,8 @@ pub struct Config {
|
||||
pub compact_prompt: Option<String>,
|
||||
|
||||
/// Optional commit attribution text for commit message co-author trailers.
|
||||
/// This top-level setting only takes effect when `[features].codex_git_commit`
|
||||
/// is enabled.
|
||||
///
|
||||
/// - `None`: use default attribution (`Codex <noreply@openai.com>`)
|
||||
/// - `Some("")` or whitespace-only: disable commit attribution
|
||||
|
||||
@@ -5,3 +5,24 @@ For basic configuration instructions, see [this documentation](https://developer
|
||||
For advanced configuration instructions, see [this documentation](https://developers.openai.com/codex/config-advanced).
|
||||
|
||||
For a full configuration reference, see [this documentation](https://developers.openai.com/codex/config-reference).
|
||||
|
||||
## Commit attribution
|
||||
|
||||
Codex can add a [git trailer](https://git-scm.com/docs/git-interpret-trailers) to
|
||||
generated commit messages so commits make Codex's involvement explicit. This
|
||||
behavior is gated by the `codex_git_commit` feature flag; the top-level
|
||||
`commit_attribution` setting is only used when that feature is enabled.
|
||||
|
||||
Add the following to `~/.codex/config.toml`:
|
||||
|
||||
```toml
|
||||
commit_attribution = "Codex <noreply@openai.com>"
|
||||
|
||||
[features]
|
||||
codex_git_commit = true
|
||||
```
|
||||
|
||||
When enabled, Codex appends a `Co-authored-by:` trailer using the configured
|
||||
attribution value. If `commit_attribution` is omitted, Codex uses
|
||||
`Codex <noreply@openai.com>`. Set `commit_attribution = ""` to disable the
|
||||
trailer while leaving the feature flag enabled.
|
||||
|
||||
Reference in New Issue
Block a user