feat: changelog docs major improvement - #26138
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8ffbadf8a6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2518bd1d6b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
pront
added
the
no-changelog
a83421f to
47cecd0
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 82fdceef64
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bfd46bc359
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
pront
changed the title
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 871fcfda43
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Centralize the changelog fragment type list in a single source of truth (`FRAGMENT_TYPES` in vdev/src/commands/changelog/mod.rs), where each type carries a name, description, release CUE type, and breaking flag, and expose it through a new `vdev changelog types` subcommand. The scaffolder, CI checker, and release CUE generator all derive from the shared definition instead of maintaining duplicated lists or hard-coded matches. Restructure changelog.d/README.md: add prerequisites/install guidance, clarify when a fragment is needed, document what a good fragment should answer, reference `vdev changelog types` as the source of truth for types and their descriptions, and clarify that the authors line is required. Bump vdev to 0.3.15.
ad2dac0 to
f6a731a
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f6a731a461
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
2 participants
Summary
Centralize the changelog fragment type list in a single source of truth and expose it
through a new
vdev changelog typessubcommand, so the scaffolder, CI checker, and releasegenerator no longer maintain duplicated lists (the checker previously carried a
"keep this list in sync" comment). Update
changelog.d/README.mdto reference the commandinstead of hardcoding the types, and add guidance for both humans and agents.
References
No issue.
Vector configuration
N/A — this PR touches vdev developer tooling and
changelog.d/README.mdonly.How did you test this PR?
cargo check -p vdevcargo test -p vdev— 116 passed (including a new test forvdev changelog types)cargo clippy -p vdev --all-targetscargo fmt -p vdev -- --checkvdev check markdown— 0 issues across 707 filesvdev changelog typesprints each type with its description (e.g.breaking A change that is incompatible with prior versions and requires users to make adjustments...),and
vdev changelog --helplists the new subcommand.Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.Contributor Guidelines
@vectordotdev/vectorto reach out to us regarding this PR.pre-pushhook (template) or run the following locally before pushing:make fmtmake check-clippy(auto-fix withmake clippy-fix)make testgit merge origin masterandgit push.Cargo.lock), pleaserun
make build-licensesto regenerate the license inventory and commit the changes (if any). More details on the dd-rust-license-tool.