Skip to content

Commit 4be974c

Browse files
authored
docs: update history related (envoyproxy#21231)
Signed-off-by: Loong Dai <[email protected]>
1 parent 81cebf6 commit 4be974c

File tree

4 files changed

+29
-61
lines changed

4 files changed

+29
-61
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ versioning guidelines:
109109
build. If your PR cannot have 100% coverage for some reason please clearly explain why when you
110110
open it.
111111
* Any PR that changes user-facing behavior **must** have associated documentation in [docs](docs) as
112-
well as [release notes](docs/root/version_history/current.rst). API changes should be documented
112+
well as [release notes](changelogs/current.yaml). API changes should be documented
113113
inline with protos as per the [API contribution guidelines](api/CONTRIBUTING.md). If a change applies
114114
to multiple sections of the release notes, it should be noted in the first (most important) section
115115
that applies. For instance, a bug fix that introduces incompatible behavior should be noted in
@@ -150,7 +150,7 @@ versioning guidelines:
150150
changes for 7 days. Obviously PRs that are closed due to lack of activity can be reopened later.
151151
Closing stale PRs helps us to keep on top of all of the work currently in flight.
152152
* If a commit deprecates a feature, the commit message must mention what has been deprecated.
153-
Additionally, the [version history](docs/root/version_history/current.rst) must be updated with
153+
Additionally, the [version history](changelogs/current.yaml) must be updated with
154154
relevant RST links for fields and messages as part of the commit.
155155
* Please consider joining the [envoy-dev](https://groups.google.com/forum/#!forum/envoy-dev)
156156
mailing list.
@@ -219,11 +219,12 @@ Runtime code is held to the same standard as regular Envoy code, so both the old
219219
path and the new should have 100% coverage both with the feature defaulting true
220220
and false.
221221

222-
Please note that if adding a runtime guarded feature, your [release notes](docs/root/version_history/current.rst) should include both the functional change, and how to revert it, for example
222+
Please note that if adding a runtime guarded feature, your [release notes](changelogs/current.yaml) should include both the functional change, and how to revert it, for example
223223

224-
```rst
225-
* http: changed the ``:scheme`` header to ``:schema``. This behavioral change can be
226-
temporarily reverted by setting runtime guard ``envoy.reloadable_features.schema_is_better_than_scheme`` to false.
224+
```yaml
225+
- area: config
226+
change: |
227+
type URL is used to lookup extensions regardless of the name field. This may cause problems for empty filter configurations or mis-matched protobuf as the typed configurations. This behavioral change can be temporarily reverted by setting runtime guard ``envoy.reloadable_features.no_extension_lookup_by_name`` to false.
227228
```
228229
229230
# PR review policy for maintainers

PULL_REQUESTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Request](https://www.envoyproxy.io/docs/envoy/latest/intro/life_of_a_request) do
6565
### <a name="relnotes"></a>Release notes
6666

6767
If this change is user impacting OR extension developer impacting (filter API, etc.) you **must**
68-
add a release note to the [version history](docs/root/version_history/current.rst) for the
68+
add a release note to the [version history](changelogs/current.yaml) for the
6969
current version. Please include any relevant links. Each release note should be prefixed with the
7070
relevant subsystem in **alphabetical order** (see existing examples as a guide) and include links
7171
to relevant parts of the documentation. Thank you! Please write in N/A if there are no release notes.
@@ -118,7 +118,7 @@ merged.
118118
### <a name="deprecated"></a>Deprecated
119119

120120
If this PR deprecates existing Envoy APIs or code, it should include an update to the deprecated
121-
section of the [version history](docs/root/version_history/current.rst) and a one line note in the
121+
section of the [version history](changelogs/current.yaml) and a one line note in the
122122
PR description.
123123

124124
If you mark existing APIs or code as deprecated, when the next release is cut, the

RELEASES.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@ deadline of 3 weeks.
100100
* Begin marshalling the ongoing PR flow in this repo. Ask maintainers to hold off merging any
101101
particularly risky PRs until after the release is tagged. This is because we aim for main to be
102102
at release candidate quality at all times.
103-
* Do a final check of the [release notes](docs/root/version_history/current.rst):
103+
* Do a final check of the [release notes](changelogs/current.yaml):
104104
* Make any needed corrections (grammar, punctuation, formatting, etc.).
105105
* Check to see if any security/stable version release notes are duplicated in
106106
the major version release notes. These should not be duplicated.
107107
* If the "Deprecated" section is empty, delete it.
108-
* Remove the "Pending" tags and add dates to the top of the [release notes for this version](docs/root/version_history/current.rst).
108+
* Remove the "Pending" tags and add dates to the top of the [release notes for this version](changelogs/current.yaml).
109109
* Switch the [VERSION.txt](VERSION.txt) from a "dev" variant to a final variant. E.g., "1.6.0-dev" to
110110
"1.6.0".
111111
* Update the [RELEASES](RELEASES.md) doc with the relevant dates. Now, or after you cut the
@@ -129,45 +129,37 @@ deadline of 3 weeks.
129129
post.
130130
* Do a new PR to setup the next version
131131
* Update [VERSION.txt](VERSION.txt) to the next development release. E.g., "1.7.0-dev".
132-
* `git mv docs/root/version_history/current.rst docs/root/version_history/v1.6.0.rst`, filling in the previous
132+
* `git mv changelogs/current.yaml changelogs/1.6.0.yaml`, filling in the previous
133133
release version number in the filename and delete empty sections (like Incompatible Behavior Changes, Minor Bahavior Changes, etc).
134134
Add an entry for the new file in the `toctree` in
135135
[version_history.rst](docs/root/version_history/version_history.rst).
136136
* Edit the file you just created (eg `docs/root/version_history/v1.6.0.rst`) replacing the link part (between the `<>`) of any `ref:` links to point at the version - eg `` :ref:`Some link text <actual link>` `` -> `` :ref:`Some link text <v1.16:actual link>` ``
137137
* Create a new "current" version history file at the [release
138-
notes](docs/root/version_history/current.rst) for the following version. E.g., "1.7.0 (pending)". Use
138+
notes](changelogs/current.yaml) for the following version. E.g., "1.7.0 (pending)". Use
139139
this text as the template for the new file:
140-
```
141-
1.7.0 (Pending)
142-
===============
140+
```yaml
141+
date: Pending
142+
behavior_changes:
143+
# Changes that are expected to cause an incompatibility if applicable; deployment changes are likely required
143144

144-
Incompatible Behavior Changes
145-
-----------------------------
146-
*Changes that are expected to cause an incompatibility if applicable; deployment changes are likely required*
145+
minor_behavior_changes:
146+
# Changes that may cause incompatibilities for some users, but should not for most*
147147

148-
Minor Behavior Changes
149-
----------------------
150-
*Changes that may cause incompatibilities for some users, but should not for most*
148+
bug_fixes:
149+
# Changes expected to improve the state of the world and are unlikely to have negative effects*
151150

152-
Bug Fixes
153-
---------
154-
*Changes expected to improve the state of the world and are unlikely to have negative effects*
151+
removed_config_or_runtime:
152+
# Normally occurs at the end of the* :ref:`deprecation period <deprecated>`
155153

156-
Removed Config or Runtime
157-
-------------------------
158-
*Normally occurs at the end of the* :ref:`deprecation period <deprecated>`
154+
new_features:
159155

160-
New Features
161-
------------
156+
deprecated:
162157

163-
Deprecated
164-
----------
158+
# Run the deprecate_versions.py script (e.g. `bazel run //tools/deprecate_version:deprecate_version`)
159+
# to file tracking issues for runtime guarded code which can be removed.
160+
# Check source/common/runtime/runtime_features.cc and see if any runtime guards in
161+
# disabled_runtime_features should be reassessed, and ping on the relevant issues.
165162
```
166-
* Run the deprecate_versions.py script (e.g. `bazel run //tools/deprecate_version:deprecate_version`)
167-
to file tracking issues for runtime guarded code which can be removed.
168-
* Check source/common/runtime/runtime_features.cc and see if any runtime guards in
169-
disabled_runtime_features should be reassessed, and ping on the relevant issues.
170-
171163

172164
## Security release schedule
173165

tools/testdata/check_format/version_history/current.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)