E570 Merge branch '5.2' into 5.x · symfony/symfony-docs@a45d678 · GitHub
[go: up one dir, main page]
Skip to content

Commit a45d678

Browse files
OskarStarkOskarStark
committed
Merge branch '5.2' into 5.x
* 5.2: [Notifier] Update information for slack on actual implementation Update http_cache.rst [Security] Minor typo [Console] Update questionhelper.rst Rewords Update index.rst [Validator] Removing the recommended `Constraints` subdirectory Fix code example Update database.rst Fixing uppercase typo Update performance.rst Tweaks Update messenger.rst Delete duplicated words [Notifier] Add better example for Slack DSN Update events.rst Enhancement: Add /me to the CODEOWNERS file for GithubActions workflows A method call is reversed Add a note about exposing env vars for unrecognized Docker services Update event_dispatcher.rst
2 parents 29c9eda + aece272 commit a45d678

File tree

15 files changed

+58
-39
lines changed

15 files changed

+58
-39
lines changed

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# GithubActions workflows
2+
/.github/workflows* @OskarStark
3+
14
# Console
25
/console* @chalasr
36
/components/console* @chalasr

‎components/console/helpers/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ The Console Helpers
1515
debug_formatter
1616

1717
The Console component comes with some useful helpers. These helpers contain
18-
function to ease some common tasks.
18+
functions to ease some common tasks.
1919

2020
.. include:: map.rst.inc

‎components/console/helpers/progressbar.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,8 +348,8 @@ placeholder before displaying the progress bar::
348348
$progressBar->start();
349349
// 0/100 -- Start
350350

351-
$progressBar->advance();
352351
$progressBar->setMessage('Task is in progress...');
352+
$progressBar->advance();
353353
// 1/100 -- Task is in progress...
354354

355355
Messages can be combined with custom placeholders too. In this example, the

‎components/console/helpers/questionhelper.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ helper set, which you can get by calling
1212
$helper = $this->getHelper('question');
1313

1414
The Question Helper has a single method
15-
:method:`Symfony\\Component\\Console\\Command\\Command::ask` that needs an
15+
:method:`Symfony\\Component\\Console\\Helper\\QuestionHelper::ask` that needs an
1616
:class:`Symfony\\Component\\Console\\Input\\InputInterface` instance as the
1717
first argument, an :class:`Symfony\\Component\\Console\\Output\\OutputInterface`
1818
instance as the second argument and a

‎doctrine/events.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ on other common tasks (e.g. ``loadClassMetadata``, ``onClear``).
1616

1717
There are different ways to listen to these Doctrine events:
1818

19-
* **Lifecycle callbacks**, they are defined as methods on the entity classes and
19+
* **Lifecycle callbacks**, they are defined as public methods on the entity classes and
2020
they are called when the events are triggered;
2121
* **Lifecycle listeners and subscribers**, they are classes with callback
2222
methods for one or more events and they are called for all entities;
@@ -46,7 +46,7 @@ to learn everything about them.
4646
Doctrine Lifecycle Callbacks
4747
----------------------------
4848

49-
Lifecycle callbacks are defined as methods inside the entity you want to modify.
49+
Lifecycle callbacks are defined as public methods inside the entity you want to modify.
5050
For example, suppose you want to set a ``createdAt`` date column to the current
5151
date, but only when the entity is first persisted (i.e. inserted). To do so,
5252
define a callback for the ``prePersist`` Doctrine event:

‎event_dispatcher.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ using a special "tag":
108108
$services = $configurator->services();
109109
110110
$services->set(ExceptionListener::class)
111-
->addTag('kernel.event_listener', ['event' => 'kernel.exception'])
111+
->tag('kernel.event_listener', ['event' => 'kernel.exception'])
112112
;
113113
};
114114

‎http_cache.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Safe Methods: Only caching GET or HEAD requests
310310
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311311

312312
HTTP caching only works for "safe" HTTP methods (like GET and HEAD). This means
313-
two things:
313+
three things:
314314

315315
* Don't try to cache PUT or DELETE requests. It won't work and with good reason.
316316
These methods are meant to be used when mutating the state of your application

‎messenger.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1339,7 +1339,7 @@ The transport has a number of options:
13391339
====================== ====================================== ===================================
13401340
``access_key`` AWS access key
13411341
``account`` Identifier of the AWS account The owner of the credentials
1342-
``auto_setup`` Whether the table should be created ``true``
1342+
``auto_setup`` Whether the queue should be created ``true``
13431343
automatically during send / get.
13441344
``buffer_size`` Number of messages to prefetch 9
13451345
``endpoint`` Absolute URL to the SQS service https://sqs.eu-west-1.amazonaws.com

‎notifier.rst‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,27 +145,26 @@ GoogleChat ``symfony/google-chat-notifier`` ``googlechat://ACCESS_KEY:ACCESS_T
145145
LinkedIn ``symfony/linked-in-notifier`` ``linkedin://TOKEN:USER_ID@default``
146146
Mattermost ``symfony/mattermost-notifier`` ``mattermost://TOKEN@ENDPOINT?channel=CHANNEL``
147147
RocketChat ``symfony/rocket-chat-notifier`` ``rocketchat://TOKEN@ENDPOINT?channel=CHANNEL``
148-
Slack ``symfony/slack-notifier`` ``slack://default/ID``
148+
Slack ``symfony/slack-notifier`` ``slack://TOKEN@default?channel=CHANNEL``
149149
Telegram ``symfony/telegram-notifier`` ``telegram://TOKEN@default?channel=CHAT_ID``
150150
Zulip ``symfony/zulip-notifier`` ``zulip://EMAIL:APIKEY@ENDPOINT?channel=CHANNEL``
151151
========== ================================ ===========================================================================
152152

153153
.. versionadded:: 5.1
154154

155-
The Mattermost and RocketChat integrations were introduced in Symfony
156-
5.1. The Slack DSN changed in Symfony 5.1 to use Slack Incoming
157-
Webhooks instead of legacy tokens.
155+
The Mattermost and RocketChat integrations were introduced in Symfony 5.1.
158156

159157
.. versionadded:: 5.2
160158

161159
The GoogleChat, LinkedIn, Zulip and Discord integrations were introduced in Symfony 5.2.
160+
The Slack DSN changed in Symfony 5.2 to use Slack Web API again same as in 5.0.
162161

163162
Chatters are configured using the ``chatter_transports`` setting:
164163

165164
.. code-block:: bash
166165
167166
# .env
168-
SLACK_DSN=slack://default/ID
167+
SLACK_DSN=slack://TOKEN@default?channel=CHANNEL
169168
170169
.. configuration-block::
171170

‎performance.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,14 +193,14 @@ such as Symfony projects, should use at least these values:
193193
Optimize Composer Autoloader
194194
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195195

196-
The class loader used while developing the application is optimized to find
197-
new and changed classes. In production servers, PHP files should never change,
196+
The class loader used while developing the application is optimized to find new
197+
and changed classes. In production servers, PHP files should never change,
198198
unless a new application version is deployed. That's why you can optimize
199-
Composer's autoloader to scan the entire application once and build a "class map",
200-
which is a big array of the locations of all the classes and it's stored
201-
in ``vendor/composer/autoload_classmap.php``.
199+
Composer's autoloader to scan the entire application once and build an
200+
optimized "class map", which is a big array of the locations of all the classes
201+
and it's stored in ``vendor/composer/autoload_classmap.php``.
202202

203-
Execute this command to generate the class map (and make it part of your
203+
Execute this command to generate the new class map (and make it part of your
204204
deployment process too):
205205

206206
.. code-block:: terminal

0 commit comments

Comments
 (0)
0