Skip to content
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

chore(dev): Add DEPRECATIONS.md file to track deprecations #18613

Merged
merged 4 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/minor-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ labels: "domain: releasing"

The week before the release:

- [ ] Check for any outstanding deprecation actions in [DEPRECATIONS.md](docs/DEPRECATIONS.md) and
take them (or have someone help you take them)
- [ ] Create a new release branch from master to freeze commits
- `git fetch && git checkout origin/master && git checkout -b v0.<new version number> && git push -u`
- [ ] Create a new release preparation branch from `master`
Expand Down
2 changes: 2 additions & 0 deletions docs/DEPRECATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,12 @@ When introducing a deprecation into Vector, the pull request introducing the dep
the new name will be appended with the text `(formerly OldName)`.
- Add a log message to Vector that is logged at the `WARN` level starting with the word `DEPRECATION` if Vector detects
the deprecated configuration or feature being used (when possible).
- Add the deprecation to [DEPRECATIONS.md](docs/DEPRECATIONS.md) to track migration (if applicable) and removal

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

- Indicate that it is a breaking change by including `!` in the title after the type/scope
- Remove the deprecation from the documentation
- Add a note to the Breaking Changes section of the upgrade guide for the next release with a description and directions
for transitioning if applicable.
- Remove the deprecation from [DEPRECATIONS.md](docs/DEPRECATIONS.md)
8 changes: 8 additions & 0 deletions docs/DEPRECATIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# To be deprecated

# To be migrated

* legacy_openssl_provider v0.33.0 OpenSSL legacy provider flag should default to false
Copy link
Member Author

@jszwedko jszwedko Sep 19, 2023

Choose a reason for hiding this comment

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

Using this one as an example since it is in-flight.


# To be removed

Loading