Skip to content

Commit e7ca018

Browse files
committed
Merge branch '7.2' into 7.3
* 7.2: Minor tweaks remove reference to Travis CI (no longer free) [Reference] Update the default values of some options
2 parents 2ea31b0 + b08f936 commit e7ca018

File tree

2 files changed

+23
-25
lines changed

2 files changed

+23
-25
lines changed

bundles/best_practices.rst

+9-11
Original file line numberDiff line numberDiff line change
@@ -195,25 +195,24 @@ Continuous Integration
195195

196196
Testing bundle code continuously, including all its commits and pull requests,
197197
is a good practice called Continuous Integration. There are several services
198-
providing this feature for free for open source projects, like `GitHub Actions`_
199-
and `Travis CI`_.
198+
providing this feature for free for open source projects, like `GitHub Actions`_.
200199

201200
A bundle should at least test:
202201

203202
* The lower bound of their dependencies (by running ``composer update --prefer-lowest``);
204203
* The supported PHP versions;
205-
* All supported major Symfony versions (e.g. both ``4.x`` and ``5.x`` if
204+
* All supported major Symfony versions (e.g. both ``6.4`` and ``7.x`` if
206205
support is claimed for both).
207206

208-
Thus, a bundle supporting PHP 7.3, 7.4 and 8.0, and Symfony 4.4 and 5.x should
207+
Thus, a bundle supporting PHP 7.4, 8.3 and 8.4, and Symfony 6.4 and 7.x should
209208
have at least this test matrix:
210209

211210
=========== =============== ===================
212211
PHP version Symfony version Composer flags
213212
=========== =============== ===================
214-
7.3 ``4.*`` ``--prefer-lowest``
215-
7.4 ``5.*``
216-
8.0 ``5.*``
213+
7.4 ``6.4`` ``--prefer-lowest``
214+
8.3 ``7.*``
215+
8.4 ``7.*``
217216
=========== =============== ===================
218217

219218
.. tip::
@@ -233,10 +232,10 @@ with Symfony Flex to install a specific Symfony version:
233232

234233
.. code-block:: bash
235234
236-
# this requires Symfony 5.x for all Symfony packages
237-
export SYMFONY_REQUIRE=5.*
235+
# this requires Symfony 6.x for all Symfony packages
236+
export SYMFONY_REQUIRE=6.*
238237
# alternatively you can run this command to update composer.json config
239-
# composer config extra.symfony.require "5.*"
238+
# composer config extra.symfony.require "6.*"
240239
241240
# install Symfony Flex in the CI environment
242241
composer global config --no-plugins allow-plugins.symfony/flex true
@@ -568,4 +567,3 @@ Learn more
568567
.. _`choose any license`: https://choosealicense.com/
569568
.. _`valid license identifier`: https://spdx.org/licenses/
570569
.. _`GitHub Actions`: https://docs.github.com/en/free-pro-team@latest/actions
571-
.. _`Travis CI`: https://docs.travis-ci.com/

reference/configuration/framework.rst

+14-14
Original file line numberDiff line numberDiff line change
@@ -1250,7 +1250,7 @@ allow_reload
12501250

12511251
Specifies whether the client can force a cache reload by including a
12521252
Cache-Control "no-cache" directive in the request. Set it to ``true``
1253-
for compliance with RFC 2616. (default: false)
1253+
for compliance with RFC 2616.
12541254

12551255
allow_revalidate
12561256
................
@@ -1259,7 +1259,7 @@ allow_revalidate
12591259

12601260
Specifies whether the client can force a cache revalidate by including a
12611261
Cache-Control "max-age=0" directive in the request. Set it to ``true``
1262-
for compliance with RFC 2616. (default: false)
1262+
for compliance with RFC 2616.
12631263

12641264
debug
12651265
.....
@@ -1272,11 +1272,11 @@ try to carry on and deliver a meaningful response.
12721272
default_ttl
12731273
...........
12741274

1275-
**type**: ``integer``
1275+
**type**: ``integer`` **default**: ``0``
12761276

12771277
The number of seconds that a cache entry should be considered fresh when no
12781278
explicit freshness information is provided in a response. Explicit
1279-
Cache-Control or Expires headers override this value. (default: 0)
1279+
Cache-Control or Expires headers override this value.
12801280

12811281
enabled
12821282
.......
@@ -1286,11 +1286,11 @@ enabled
12861286
private_headers
12871287
...............
12881288

1289-
**type**: ``array``
1289+
**type**: ``array`` **default**: ``['Authorization', 'Cookie']``
12901290

12911291
Set of request headers that trigger "private" cache-control behavior on responses
12921292
that don't explicitly state whether the response is public or private via a
1293-
Cache-Control directive. (default: Authorization and Cookie)
1293+
Cache-Control directive.
12941294

12951295
skip_response_headers
12961296
.....................
@@ -1303,30 +1303,30 @@ and public.
13031303
stale_if_error
13041304
..............
13051305

1306-
**type**: ``integer``
1306+
**type**: ``integer`` **default**: ``60``
13071307

13081308
Specifies the default number of seconds (the granularity is the second) during
1309-
which the cache can serve a stale response when an error is encountered
1310-
(default: 60). This setting is overridden by the stale-if-error HTTP
1309+
which the cache can serve a stale response when an error is encountered.
1310+
This setting is overridden by the stale-if-error HTTP
13111311
Cache-Control extension (see RFC 5861).
13121312

13131313
stale_while_revalidate
13141314
......................
13151315

1316-
**type**: ``integer``
1316+
**type**: ``integer`` **default**: ``2``
13171317

13181318
Specifies the default number of seconds (the granularity is the second as the
13191319
Response TTL precision is a second) during which the cache can immediately return
1320-
a stale response while it revalidates it in the background (default: 2).
1320+
a stale response while it revalidates it in the background.
13211321
This setting is overridden by the stale-while-revalidate HTTP Cache-Control
13221322
extension (see RFC 5861).
13231323

13241324
trace_header
13251325
............
13261326

1327-
**type**: ``string``
1327+
**type**: ``string`` **default**: ``'X-Symfony-Cache'``
13281328

1329-
Header name to use for traces. (default: X-Symfony-Cache)
1329+
Header name to use for traces.
13301330

13311331
trace_level
13321332
...........
@@ -1335,7 +1335,7 @@ trace_level
13351335

13361336
For 'short', a concise trace of the main request will be added as an HTTP header.
13371337
'full' will add traces for all requests (including ESI subrequests).
1338-
(default: 'full' if in debug; 'none' otherwise)
1338+
(default: ``'full'`` if in debug; ``'none'`` otherwise)
13391339

13401340
.. _reference-http-client:
13411341

0 commit comments

Comments
 (0)