Merge branch '5.2' into 5.x

OskarStark · OskarStark · commit a45d678d59c7 · 2020-12-04T08:51:04.000+01:00
* 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
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,3 +1,6 @@
+# GithubActions workflows
+/.github/workflows* @OskarStark
+
 # Console
 /console* @chalasr
 /components/console* @chalasr
diff --git a/components/console/helpers/index.rst b/components/console/helpers/index.rst
@@ -15,6 +15,6 @@ The Console Helpers
     debug_formatter
 
 The Console component comes with some useful helpers. These helpers contain
-function to ease some common tasks.
+functions to ease some common tasks.
 
 .. include:: map.rst.inc
diff --git a/components/console/helpers/progressbar.rst b/components/console/helpers/progressbar.rst
@@ -348,8 +348,8 @@ placeholder before displaying the progress bar::
     $progressBar->start();
     // 0/100 -- Start
 
-    $progressBar->advance();
     $progressBar->setMessage('Task is in progress...');
+    $progressBar->advance();    
     // 1/100 -- Task is in progress...
 
 Messages can be combined with custom placeholders too. In this example, the
diff --git a/components/console/helpers/questionhelper.rst b/components/console/helpers/questionhelper.rst
@@ -12,7 +12,7 @@ helper set, which you can get by calling
     $helper = $this->getHelper('question');
 
 The Question Helper has a single method
-:method:`Symfony\\Component\\Console\\Command\\Command::ask` that needs an
+:method:`Symfony\\Component\\Console\\Helper\\QuestionHelper::ask` that needs an
 :class:`Symfony\\Component\\Console\\Input\\InputInterface` instance as the
 first argument, an :class:`Symfony\\Component\\Console\\Output\\OutputInterface`
 instance as the second argument and a
diff --git a/doctrine/events.rst b/doctrine/events.rst
@@ -16,7 +16,7 @@ on other common tasks (e.g. ``loadClassMetadata``, ``onClear``).
 
 There are different ways to listen to these Doctrine events:
 
-* **Lifecycle callbacks**, they are defined as methods on the entity classes and
+* **Lifecycle callbacks**, they are defined as public methods on the entity classes and
   they are called when the events are triggered;
 * **Lifecycle listeners and subscribers**, they are classes with callback
   methods for one or more events and they are called for all entities;
@@ -46,7 +46,7 @@ to learn everything about them.
 Doctrine Lifecycle Callbacks
 ----------------------------
 
-Lifecycle callbacks are defined as methods inside the entity you want to modify.
+Lifecycle callbacks are defined as public methods inside the entity you want to modify.
 For example, suppose you want to set a ``createdAt`` date column to the current
 date, but only when the entity is first persisted (i.e. inserted). To do so,
 define a callback for the ``prePersist`` Doctrine event:
diff --git a/event_dispatcher.rst b/event_dispatcher.rst
@@ -108,7 +108,7 @@ using a special "tag":
             $services = $configurator->services();
 
             $services->set(ExceptionListener::class)
-                ->addTag('kernel.event_listener', ['event' => 'kernel.exception'])
+                ->tag('kernel.event_listener', ['event' => 'kernel.exception'])
             ;
         };
 
diff --git a/http_cache.rst b/http_cache.rst
@@ -310,7 +310,7 @@ Safe Methods: Only caching GET or HEAD requests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 HTTP caching only works for "safe" HTTP methods (like GET and HEAD). This means
-two things:
+three things:
 
 * Don't try to cache PUT or DELETE requests. It won't work and with good reason.
   These methods are meant to be used when mutating the state of your application
diff --git a/messenger.rst b/messenger.rst
@@ -1339,7 +1339,7 @@ The transport has a number of options:
 ======================  ======================================  ===================================
 ``access_key``          AWS access key
 ``account``             Identifier of the AWS account           The owner of the credentials
-``auto_setup``          Whether the table should be created     ``true``
+``auto_setup``          Whether the queue should be created     ``true``
                         automatically during send / get.
 ``buffer_size``         Number of messages to prefetch          9
 ``endpoint``            Absolute URL to the SQS service         https://sqs.eu-west-1.amazonaws.com
diff --git a/notifier.rst b/notifier.rst
@@ -145,27 +145,26 @@ GoogleChat  ``symfony/google-chat-notifier``  ``googlechat://ACCESS_KEY:ACCESS_T
 LinkedIn    ``symfony/linked-in-notifier``    ``linkedin://TOKEN:USER_ID@default``
 Mattermost  ``symfony/mattermost-notifier``   ``mattermost://TOKEN@ENDPOINT?channel=CHANNEL``
 RocketChat  ``symfony/rocket-chat-notifier``  ``rocketchat://TOKEN@ENDPOINT?channel=CHANNEL``
-Slack       ``symfony/slack-notifier``        ``slack://default/ID``
+Slack       ``symfony/slack-notifier``        ``slack://TOKEN@default?channel=CHANNEL``
 Telegram    ``symfony/telegram-notifier``     ``telegram://TOKEN@default?channel=CHAT_ID``
 Zulip       ``symfony/zulip-notifier``        ``zulip://EMAIL:APIKEY@ENDPOINT?channel=CHANNEL``
 ==========  ================================  ===========================================================================
 
 .. versionadded:: 5.1
 
-    The Mattermost and RocketChat integrations were introduced in Symfony
-    5.1. The Slack DSN changed in Symfony 5.1 to use Slack Incoming
-    Webhooks instead of legacy tokens.
+    The Mattermost and RocketChat integrations were introduced in Symfony 5.1.
 
 .. versionadded:: 5.2
 
     The GoogleChat, LinkedIn, Zulip and Discord integrations were introduced in Symfony 5.2.
+    The Slack DSN changed in Symfony 5.2 to use Slack Web API again same as in 5.0.
 
 Chatters are configured using the ``chatter_transports`` setting:
 
 .. code-block:: bash
 
     # .env
-    SLACK_DSN=slack://default/ID
+    SLACK_DSN=slack://TOKEN@default?channel=CHANNEL
 
 .. configuration-block::
 
diff --git a/performance.rst b/performance.rst
@@ -193,14 +193,14 @@ such as Symfony projects, should use at least these values:
 Optimize Composer Autoloader
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The class loader used while developing the application is optimized to find
-new and changed classes. In production servers, PHP files should never change,
+The class loader used while developing the application is optimized to find new
+and changed classes. In production servers, PHP files should never change,
 unless a new application version is deployed. That's why you can optimize
-Composer's autoloader to scan the entire application once and build a "class map",
-which is a big array of the locations of all the classes and it's stored
-in ``vendor/composer/autoload_classmap.php``.
+Composer's autoloader to scan the entire application once and build an
+optimized "class map", which is a big array of the locations of all the classes
+and it's stored in ``vendor/composer/autoload_classmap.php``.
 
-Execute this command to generate the class map (and make it part of your
+Execute this command to generate the new class map (and make it part of your
 deployment process too):
 
 .. code-block:: terminal
diff --git a/security/experimental_authenticators.rst b/security/experimental_authenticators.rst
@@ -375,7 +375,7 @@ The authenticator can be enabled using the ``custom_authenticators`` setting:
                         - App\Security\ApiKeyAuthenticator
 
                     # don't forget to also configure the entry_point if the
-                    # authenticator implements AuthenticatorEntryPointInterface
+                    # authenticator implements AuthenticationEntryPointInterface
                     # entry_point: App\Security\CustomFormLoginAuthenticator
 
     .. code-block:: xml
@@ -447,7 +447,7 @@ well as other pieces of information, like whether a password should be checked
 or if "remember me" functionality should be enabled.
 
 The default
-:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Passport`.
+:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Passport`
 requires a user object and credentials. The following credential classes
 are supported by default:
 
diff --git a/service_container/tags.rst b/service_container/tags.rst
@@ -785,9 +785,9 @@ indexed by the ``key`` attribute:
         };
 
 After compilation the ``HandlerCollection`` is able to iterate over your
-application handlers. To retrieve a specific service by it's ``key`` attribute
-from the iterator, we can use ``iterator_to_array`` and retrieve the ``handler_two``:
-to get an array and then retrieve the ``handler_two`` handler::
+application handlers. To retrieve a specific service from the iterator, call the
+``iterator_to_array()`` function and then use the ``key`` attribute to get the
+array element. For example, to retrieve the ``handler_two`` handler::
 
     // src/Handler/HandlerCollection.php
     namespace App\Handler;
@@ -798,7 +798,7 @@ to get an array and then retrieve the ``handler_two`` handler::
         {
             $handlers = iterator_to_array($handlers);
 
-            $handlerTwo = $handlers['handler_two']:
+            $handlerTwo = $handlers['handler_two'];
         }
     }
 
diff --git a/setup/symfony_server.rst b/setup/symfony_server.rst
@@ -299,6 +299,9 @@ project. It understands that this is a MySQL service and creates environment
 variables accordingly with the service name (``database``) as a prefix:
 ``DATABASE_URL``, ``DATABASE_HOST``, ...
 
+If the service is not in the supported list below, generic environment
+variables are set: ``PORT``, ``IP``, and ``HOST``.
+
 If the ``docker-compose.yaml`` names do not match Symfony's conventions, add a
 label to override the environment variables prefix:
 
@@ -361,6 +364,20 @@ When Docker services are running, browse a page of your Symfony application and
 check the "Symfony Server" section in the web debug toolbar; you'll see that
 "Docker Compose" is "Up".
 
+.. note::
+
+    If you don't want environment variables to be exposed for a service, set
+    the ``com.symfony.server.service-ignore`` label to ``true``:
+
+    .. code-block:: yaml
+
+        # docker-compose.yaml
+        services:
+            db:
+                ports: [3306]
+                labels:
+                    com.symfony.server.service-ignore: true
+
 If your Docker Compose file is not at the root of the project, use the
 ``COMPOSE_FILE`` and ``COMPOSE_PROJECT_NAME`` environment variables to define
 its location, same as for ``docker-compose``:
diff --git a/testing/database.rst b/testing/database.rst
@@ -15,7 +15,7 @@ your project and define the new value for the ``DATABASE_URL`` env var:
 .. code-block:: bash
 
     # .env.test.local
-    DATABASE_URL=mysql://USERNAME:PASSWORD@127.0.0.1:3306/DB_NAME?serverVersion=5.7
+    DATABASE_URL="mysql://USERNAME:PASSWORD@127.0.0.1:3306/DB_NAME?serverVersion=5.7"
 
 .. tip::
 
diff --git a/validation/custom_constraint.rst b/validation/custom_constraint.rst
@@ -1,7 +1,7 @@
 .. index::
    single: Validation; Custom constraints
 
-How to Create a custom Validation Constraint
+How to Create a Custom Validation Constraint
 ============================================
 
 You can create a custom constraint by extending the base constraint class,
@@ -14,8 +14,8 @@ Creating the Constraint Class
 
 First you need to create a Constraint class and extend :class:`Symfony\\Component\\Validator\\Constraint`::
 
-    // src/Validator/Constraints/ContainsAlphanumeric.php
-    namespace App\Validator\Constraints;
+    // src/Validator/ContainsAlphanumeric.php
+    namespace App\Validator;
 
     use Symfony\Component\Validator\Constraint;
 
@@ -54,8 +54,8 @@ when actually performing the validation.
 
 The validator class only has one required method ``validate()``::
 
-    // src/Validator/Constraints/ContainsAlphanumericValidator.php
-    namespace App\Validator\Constraints;
+    // src/Validator/ContainsAlphanumericValidator.php
+    namespace App\Validator;
 
     use Symfony\Component\Validator\Constraint;
     use Symfony\Component\Validator\ConstraintValidator;
@@ -71,7 +71,7 @@ The validator class only has one required method ``validate()``::
             }
 
             // custom constraints should ignore null and empty values to allow
-            // other constraints (NotBlank, NotNull, etc.) take care of that
+            // other constraints (NotBlank, NotNull, etc.) to take care of that
             if (null === $value || '' === $value) {
                 return;
             }
@@ -112,7 +112,7 @@ You can use custom validators like the ones provided by Symfony itself:
         // src/Entity/AcmeEntity.php
         namespace App\Entity;
 
-        use App\Validator\Constraints as AcmeAssert;
+        use App\Validator as AcmeAssert;
         use Symfony\Component\Validator\Constraints as Assert;
 
         class AcmeEntity
@@ -135,7 +135,7 @@ You can use custom validators like the ones provided by Symfony itself:
             properties:
                 name:
                     - NotBlank: ~
-                    - App\Validator\Constraints\ContainsAlphanumeric: ~
+                    - App\Validator\ContainsAlphanumeric: ~
 
     .. code-block:: xml
 
@@ -148,7 +148,7 @@ You can use custom validators like the ones provided by Symfony itself:
             <class name="App\Entity\AcmeEntity">
                 <property name="name">
                     <constraint name="NotBlank"/>
-                    <constraint name="App\Validator\Constraints\ContainsAlphanumeric"/>
+                    <constraint name="App\Validator\ContainsAlphanumeric"/>
                 </property>
             </class>
         </constraint-mapping>
@@ -158,7 +158,7 @@ You can use custom validators like the ones provided by Symfony itself:
         // src/Entity/AcmeEntity.php
         namespace App\Entity;
 
-        use App\Validator\Constraints\ContainsAlphanumeric;
+        use App\Validator\ContainsAlphanumeric;
         use Symfony\Component\Validator\Constraints\NotBlank;
         use Symfony\Component\Validator\Mapping\ClassMetadata;
 
@@ -246,21 +246,21 @@ not to the property:
         # config/validator/validation.yaml
         App\Entity\AcmeEntity:
             constraints:
-                - App\Validator\Constraints\ProtocolClass: ~
+                - App\Validator\ProtocolClass: ~
 
     .. code-block:: xml
 
         <!-- config/validator/validation.xml -->
         <class name="App\Entity\AcmeEntity">
-            <constraint name="App\Validator\Constraints\ProtocolClass"/>
+            <constraint name="App\Validator\ProtocolClass"/>
         </class>
 
     .. code-block:: php
 
         // src/Entity/AcmeEntity.php
         namespace App\Entity;
 
-        use App\Validator\Constraints\ProtocolClass;
+        use App\Validator\ProtocolClass;
         use Symfony\Component\Validator\Mapping\ClassMetadata;
 
         class AcmeEntity

Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ using a special "tag":`
`108`	`108`	`$services = $configurator->services();`
`109`	`109`
`110`	`110`	`$services->set(ExceptionListener::class)`
`111`		`- ->addTag('kernel.event_listener', ['event' => 'kernel.exception'])`
	`111`	`+ ->tag('kernel.event_listener', ['event' => 'kernel.exception'])`
`112`	`112`	`;`
`113`	`113`	`};`
`114`	`114`