You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-6Lines changed: 7 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ versioning guidelines:
109
109
build. If your PR cannot have 100% coverage for some reason please clearly explain why when you
110
110
open it.
111
111
* 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
113
113
inline with protos as per the [API contribution guidelines](api/CONTRIBUTING.md). If a change applies
114
114
to multiple sections of the release notes, it should be noted in the first (most important) section
115
115
that applies. For instance, a bug fix that introduces incompatible behavior should be noted in
@@ -150,7 +150,7 @@ versioning guidelines:
150
150
changes for 7 days. Obviously PRs that are closed due to lack of activity can be reopened later.
151
151
Closing stale PRs helps us to keep on top of all of the work currently in flight.
152
152
* 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
154
154
relevant RST links for fields and messages as part of the commit.
155
155
* Please consider joining the [envoy-dev](https://groups.google.com/forum/#!forum/envoy-dev)
156
156
mailing list.
@@ -219,11 +219,12 @@ Runtime code is held to the same standard as regular Envoy code, so both the old
219
219
path and the new should have 100% coverage both with the feature defaulting true
220
220
and false.
221
221
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
223
223
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.
* 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>` ``
137
137
* 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
139
139
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
143
144
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*
147
147
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*
151
150
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>`
155
153
156
-
Removed Config or Runtime
157
-
-------------------------
158
-
*Normally occurs at the end of the* :ref:`deprecation period <deprecated>`
154
+
new_features:
159
155
160
-
New Features
161
-
------------
156
+
deprecated:
162
157
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.
165
162
```
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.
0 commit comments