-
Notifications
You must be signed in to change notification settings - Fork 2.2k
feat(releasing): add deprecation.d fragment system #25442
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
ed0d6b0
feat(releasing): add deprecation.d fragment system
pront 4f4187f
fix(website): match deprecation versions exactly on release pages
pront 7eed9dc
docs(deprecation.d): point lifecycle and validation at the new commands
pront 4733eb4
docs(deprecation policy): treat deprecation.d as the canonical source
pront cafe897
chore(website): move deprecations page out of /releases/
pront 115691d
docs(deprecation policy): align lifecycle sections with fragment-firs…
pront b83712f
docs(deprecation policy): tighten the deprecation changelog fragment …
pront 8fefac8
docs(deprecation policy): expand the docs-note step
pront 92988b0
chore(release template): drop the `deprecation enact` step
pront a2fe171
docs(deprecation policy): announcements are not changes, removals are
pront 10bfc8f
docs(deprecation policy): require prior announcement for breaking cha…
pront fb0fae0
chore(website): simplify deprecation cue schema
pront 61981eb
fix(website): drop "Enacted Deprecations" from per-release pages
pront File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| name: Deprecation Fragments | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| ref: | ||
| description: "Git ref to checkout" | ||
| required: false | ||
| type: string | ||
|
|
||
| workflow_dispatch: | ||
| inputs: | ||
| ref: | ||
| description: "Git ref to checkout" | ||
| required: false | ||
| type: string | ||
|
|
||
| pull_request: | ||
| merge_group: | ||
| types: [checks_requested] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.number || github.sha }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| changes: | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| uses: ./.github/workflows/changes.yml | ||
| secrets: inherit | ||
|
|
||
| check-deprecations: | ||
| runs-on: ubuntu-24.04 | ||
| timeout-minutes: 10 | ||
| if: ${{ always() && (github.event_name != 'pull_request' || needs.changes.outputs.deprecations == 'true') }} | ||
| needs: [changes] | ||
| steps: | ||
| - name: Checkout branch | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| ref: ${{ inputs.ref }} | ||
| fetch-tags: true | ||
|
|
||
| - uses: ./.github/actions/setup | ||
| with: | ||
| vdev: true | ||
| mold: false | ||
|
|
||
| - name: Check deprecation fragments | ||
| run: vdev deprecation check |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # deprecation.d | ||
|
|
||
| This directory contains deprecation notices for Vector. | ||
|
|
||
| Each file describes a feature, configuration option, or behavior that is being deprecated. | ||
| These notices are collected during the release process and rendered into two sections of the | ||
| release notes: | ||
|
|
||
| - **`deprecation_announcements`** – items deprecated in this release (announced for the first time). | ||
| - **`planned_deprecations`** – items deprecated in an earlier release. | ||
|
|
||
| ## File format | ||
|
|
||
| Each file must be named `<unique_slug>.md` and begin with YAML frontmatter: | ||
|
|
||
| ````markdown | ||
| --- | ||
| what: "`legacy_auth` configuration option" | ||
| deprecated_since: "0.57.0" | ||
| --- | ||
|
|
||
| The `legacy_auth` option has been replaced by the new `auth` block. | ||
|
|
||
| Migrate by replacing: | ||
|
|
||
| ```yaml | ||
| legacy_auth: "my_token" | ||
| ``` | ||
|
|
||
| with: | ||
|
|
||
| ```yaml | ||
| auth: | ||
| token: "my_token" | ||
| ``` | ||
| ```` | ||
|
|
||
| ### Frontmatter fields | ||
|
|
||
| | Field | Required | Description | | ||
| | ----- | -------- | ----------- | | ||
| | `what` | Yes | Short one-line description of what is deprecated. | | ||
| | `deprecated_since` | Yes | The release version in which this deprecation was first announced. Accepts a semver string (`0.56`, `0.56.0`). | | ||
|
|
||
| ### Body | ||
|
|
||
| The body of the file is an optional Markdown explanation: migration instructions, rationale, | ||
| or links to further documentation. It is rendered verbatim in the release notes. | ||
|
|
||
| ## Lifecycle | ||
|
|
||
| 1. **Announce** – a PR adds a file to this directory when the deprecation is first introduced. | ||
| 2. **Planned** – every subsequent release lists the entry under `planned_deprecations`. | ||
| 3. **Removed** – when a deprecated feature is finally removed, the PR runs | ||
| `cargo vdev deprecation enact <slug> --version <removed-in-version>`. The command | ||
| records the removal in `website/data/deprecations.json` and deletes the fragment in | ||
| one step; deleting the fragment manually would drop it from `past_deprecations`. | ||
|
|
||
| ## Validation | ||
|
|
||
| Run `cargo vdev deprecation check` to validate all files in this directory. | ||
|
|
||
| To preview the current deprecation state, run `cargo vdev deprecation show`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| what: "`azure_monitor_logs` sink" | ||
| deprecated_since: "0.54.0" | ||
| --- | ||
|
|
||
| The `azure_monitor_logs` sink is deprecated in favor of the new `azure_logs_ingestion` sink, | ||
| which uses the Azure Monitor Logs Ingestion API. | ||
|
|
||
| Users should migrate before Microsoft ends support for the old Data Collector API (scheduled | ||
| for September 2026). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| what: "Boolean syntax for the `compression` field in the `vector` sink" | ||
| deprecated_since: "0.56.0" | ||
| --- | ||
|
|
||
| The boolean syntax (`compression: true` / `compression: false`) is deprecated. | ||
| Use the string syntax instead: `compression: "gzip"`, `compression: "zstd"`, or `compression: "none"`. | ||
|
|
||
| The `bool_or_vector_compression` deserializer will be removed once the boolean syntax is no longer supported. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| what: "`buffer_byte_size` and `buffer_events` gauge metrics" | ||
| deprecated_since: "0.53.0" | ||
| --- | ||
|
|
||
| The `buffer_byte_size` and `buffer_events` gauges are deprecated in favor of the | ||
| `buffer_size_bytes` and `buffer_size_events` metrics. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| what: "`series_api_version: v1` option on the `datadog_metrics` sink" | ||
| deprecated_since: "0.56.0" | ||
| --- | ||
|
|
||
| The `series_api_version: v1` option is deprecated in favor of `v2` (the default). | ||
| The v1 series endpoint (`/api/v1/series`) is a legacy endpoint. | ||
|
|
||
| Users should remove `series_api_version: v1` from their configuration or set it to `v2`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| what: "`encoding` field on HTTP server sources" | ||
| deprecated_since: "0.50.0" | ||
| --- | ||
|
|
||
| The `encoding` field will be removed. Use `decoding` and `framing` instead. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.