Skip to content

Commit d8f36e4

Browse files
authored
chore(dev): Add DEPRECATIONS.md file to track deprecations (vectordotdev#18613)
* chore(dev): Add DEPRECATIONS.md file to track deprecations Add a file to track deprecations through their lifecycle and remind us to come back to take any deprecation actions as part of each release. See vectordotdev#14983 for the process proposal. The intent is to make sure we follow through on deprecations, migrations, and removals. Closes: vectordotdev#14983 Signed-off-by: Jesse Szwedko <[email protected]> * Update process in DEPRECATION.md too Signed-off-by: Jesse Szwedko <[email protected]> * Remove from "to be removed" Will instead be added once the migration step is complete Signed-off-by: Jesse Szwedko <[email protected]> * Fix markdown headers and add link to process Signed-off-by: Jesse Szwedko <[email protected]> --------- Signed-off-by: Jesse Szwedko <[email protected]>
1 parent 75d03b3 commit d8f36e4

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

.github/ISSUE_TEMPLATE/minor-release.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ labels: "domain: releasing"
77

88
The week before the release:
99

10+
- [ ] Check for any outstanding deprecation actions in [DEPRECATIONS.md](docs/DEPRECATIONS.md) and
11+
take them (or have someone help you take them)
1012
- [ ] Create a new release branch from master to freeze commits
1113
- `git fetch && git checkout origin/master && git checkout -b v0.<new version number> && git push -u`
1214
- [ ] Create a new release preparation branch from `master`

docs/DEPRECATION.md

+2
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,12 @@ When introducing a deprecation into Vector, the pull request introducing the dep
7878
the new name will be appended with the text `(formerly OldName)`.
7979
- Add a log message to Vector that is logged at the `WARN` level starting with the word `DEPRECATION` if Vector detects
8080
the deprecated configuration or feature being used (when possible).
81+
- Add the deprecation to [DEPRECATIONS.md](docs/DEPRECATIONS.md) to track migration (if applicable) and removal
8182

8283
When removing a deprecation in a subsequent release, the pull request should:
8384

8485
- Indicate that it is a breaking change by including `!` in the title after the type/scope
8586
- Remove the deprecation from the documentation
8687
- Add a note to the Breaking Changes section of the upgrade guide for the next release with a description and directions
8788
for transitioning if applicable.
89+
- Remove the deprecation from [DEPRECATIONS.md](docs/DEPRECATIONS.md)

docs/DEPRECATIONS.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
See [DEPRECATION.md](docs/DEPRECATION.md#process) for the process for updating this file.
2+
3+
## To be deprecated
4+
5+
## To be migrated
6+
7+
* legacy_openssl_provider v0.33.0 OpenSSL legacy provider flag should default to false
8+
9+
## To be removed

0 commit comments

Comments
 (0)