Skip to content

docs(config): deprecate boolean configuration shorthand - #26680

Merged
pront merged 10 commits into
masterfrom
pront-website-bool-or-struct-deprecation
Oct 17, 2026
Merged

pront merged 10 commits into
masterfrom
pront-website-bool-or-struct-deprecation

Conversation

@pront

@pront pront commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Motivation

Boolean shorthand gives object-valued options multiple representations and hides which fields a boolean controls. Prefer explicit objects for those settings. The separate OpenTelemetry migration to decoding is already implemented in #26690.

Summary

Deprecate boolean shorthand for object-valued configuration options in 0.60.0, allowing users at least one month to migrate before removal. Removal is not yet scheduled. Add dedicated migration notes and a deserialization warning; mark only the boolean schema branch deprecated. Keep component pages free of repeated migration banners and preserve both documented healthcheck input forms and component-specific URI fields.

The general deprecation note links to the dedicated OpenTelemetry migration notice, which landed with the replacement in #26690. This PR preserves that notice unchanged.

References

Follow-up to #26669 and #26690

Vector configuration

N/A

How did you test this PR?

After rebasing onto current master:

  • Clippy with the normal default/vendored configuration, formatting, Prettier, Markdown, and deprecation validation passed.
  • Configuration/Serde compatibility and schema integration tests are still building locally. Documentation generation, the website build, and browser checks have not yet been revalidated after the rebase.

Does this PR include user facing changes?

  • Yes. Boolean shorthand now emits a deprecation warning, but remains accepted. The deprecation fragments and generated data provide the announcement; a separate changelog fragment is not required by the deprecation policy.
  • No.

Contributor Guidelines

Follow the repository contribution and pre-push guidance. Preserve incremental review history with additional signed commits.

@pront pront added the preview:website Deploy a vector.dev preview site for this PR label Oct 14, 2026
@github-actions github-actions Bot added docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. domain:external docs Anything related to Vector's external, public documentation domain:core Anything related to core crates i.e. vector-core, core-common, etc and removed docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. labels Oct 14, 2026
@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Your preview sites will be ready in a few minutes, please allow time for them to build.

Base automatically changed from pront-bool-or-struct-schema to master October 14, 2026 17:54
@pront
pront force-pushed the pront-website-bool-or-struct-deprecation branch from 5910048 to eaea297 Compare October 14, 2026 19:27
@github-actions github-actions Bot added the docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. label Oct 14, 2026
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Oct 15, 2026
@pront
pront force-pushed the pront-website-bool-or-struct-deprecation branch from 673451a to 2d65344 Compare October 16, 2026 20:41
Comment thread website/tests/reference.spec.ts Resolved
@github-actions github-actions Bot removed the docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. label Oct 16, 2026
@pront
pront marked this pull request as ready for review October 16, 2026 23:58
@pront
pront requested review from a team as code owners October 16, 2026 23:58
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-17T01:31:38.370429Z d2eb00e New commits
🔒 Security Review ✅ Completed 2026-10-17T01:29:15.264513Z d2eb00e New commits
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@pront
pront enabled auto-merge October 17, 2026 00:01

@datadoghq-integration datadoghq-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bits Code Review: PASS

More details

Boolean inputs remain accepted, and the migration examples preserve the affected settings’ defaults. Schema deprecation applies to the boolean branch while leaving the object form available.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit 2d65344

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2d65344cab

ℹ️ 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".

Comment thread lib/vector-core/src/serde.rs Resolved

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d2eb00e96d

ℹ️ 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".

Comment thread lib/vector-config/src/schema/helpers.rs Resolved
@pront
pront added this pull request to the merge queue Oct 17, 2026
Merged via the queue into master with commit 7fd2b32 Oct 17, 2026
132 checks passed
@pront
pront deleted the pront-website-bool-or-struct-deprecation branch October 17, 2026 02:13
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 17, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

domain:core Anything related to core crates i.e. vector-core, core-common, etc domain:external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog preview:website Deploy a vector.dev preview site for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants