Merge branch '6.2' into 6.3

javiereguiluz · javiereguiluz · commit 2f64d14e2d91 · 2023-04-11T10:01:20.000+02:00
* 6.2:
  Minor tweaks
  Update symfony_server.rst
  [Mailer] Link to bridges READMEs
  [Security] Document required badges
  Fix minor syntax errors
  Attributes that relate to controller arguments should start with `Map`
  Migrate the CI away from deprecated features
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -33,7 +33,7 @@ jobs:
             -   name: Get composer cache directory
                 id: composercache
                 working-directory: _build
-                run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+                run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
             -   name: Cache dependencies
                 uses: actions/cache@v3
@@ -63,7 +63,7 @@ jobs:
                 run: mkdir .cache
 
             -   name: "Extract base branch name"
-                run: echo "##[set-output name=branch;]$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})"
+                run: echo "branch=$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})" >> $GITHUB_OUTPUT
                 id: extract_base_branch
 
             -   name: "Cache DOCtor-RST"
@@ -100,12 +100,12 @@ jobs:
           - name: Find modified files
             id: find-files
             working-directory: docs
-            run: echo "::set-output name=files::$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep ".rst" | tr '\n' ' ')"
+            run: echo "files=$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep ".rst" | tr '\n' ' ')" >> $GITHUB_OUTPUT
 
           - name: Get composer cache directory
             id: composercache
             working-directory: docs/_build
-            run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+            run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
           - name: Cache dependencies
             if: ${{ steps.find-files.outputs.files }}
diff --git a/components/filesystem.rst b/components/filesystem.rst
@@ -469,12 +469,12 @@ Finding Directories/Root Directories
 PHP offers the function :phpfunction:`dirname` to obtain the directory path of a
 file path. This method has a few quirks::
 
-- `dirname()` does not accept backslashes on UNIX
-- `dirname("C:/Programs")` returns "C:", not "C:/"
-- `dirname("C:/")` returns ".", not "C:/"
-- `dirname("C:")` returns ".", not "C:/"
-- `dirname("Programs")` returns ".", not ""
-- `dirname()` does not canonicalize the result
+- ``dirname()`` does not accept backslashes on UNIX
+- ``dirname("C:/Programs")`` returns "C:", not "C:/"
+- ``dirname("C:/")`` returns ".", not "C:/"
+- ``dirname("C:")`` returns ".", not "C:/"
+- ``dirname("Programs")`` returns ".", not ""
+- ``dirname()`` does not canonicalize the result
 
 :method:`Symfony\\Component\\Filesystem\\Path::getDirectory` fixes these
 shortcomings::
diff --git a/components/runtime.rst b/components/runtime.rst
@@ -370,7 +370,7 @@ application outside of the global state in 6 steps:
    returns a :class:`Symfony\\Component\\Runtime\\RunnerInterface`: an instance
    that knows how to "run" the application object.
 #. The ``RunnerInterface::run(object $application)`` is called and it returns the
-   exit status code as `int`.
+   exit status code as ``int``.
 #. The PHP engine is terminated with this status code.
 
 When creating a new runtime, there are two things to consider: First, what arguments
diff --git a/components/workflow.rst b/components/workflow.rst
@@ -28,7 +28,7 @@ a ``Definition`` and a way to write the states to the objects (i.e. an
 instance of a :class:`Symfony\\Component\\Workflow\\MarkingStore\\MarkingStoreInterface`).
 
 Consider the following example for a blog post. A post can have one of a number
-of predefined statuses (`draft`, `reviewed`, `rejected`, `published`). In a workflow,
+of predefined statuses (``draft``, ``reviewed``, ``rejected``, ``published``). In a workflow,
 these statuses are called **places**. You can define the workflow like this::
 
     use Symfony\Component\Workflow\DefinitionBuilder;
diff --git a/contributing/code/standards.rst b/contributing/code/standards.rst
@@ -230,8 +230,11 @@ Naming Conventions
 
 * Suffix exceptions with ``Exception``;
 
-* Prefix PHP attributes with ``As`` where applicable (e.g. ``#[AsCommand]``
-  instead of ``#[Command]``, but ``#[When]`` is kept as-is);
+* Prefix PHP attributes that relate to service configuration with ``As``
+  (e.g. ``#[AsCommand]``, ``#[AsEventListener]``, etc.);
+
+* Prefix PHP attributes that relate to controller arguments with ``Map``
+  (e.g. ``#[MapEntity]``, ``#[MapCurrentUser]``, etc.);
 
 * Use UpperCamelCase for naming PHP files (e.g. ``EnvVarProcessor.php``) and
   snake case for naming Twig templates and web assets (``section_layout.html.twig``,
diff --git a/mailer.rst b/mailer.rst
@@ -99,20 +99,20 @@ Using a 3rd Party Transport
 Instead of using your own SMTP server or sendmail binary, you can send emails
 via a third-party provider:
 
-==================  ==============================================
-Service             Install with
-==================  ==============================================
-Amazon SES          ``composer require symfony/amazon-mailer``
-Infobip             ``composer require symfony/infobip-mailer``
-MailChimp           ``composer require symfony/mailchimp-mailer``
-MailerSend          ``composer require symfony/mailersend-mailer``
-Mailgun             ``composer require symfony/mailgun-mailer``
-Mailjet             ``composer require symfony/mailjet-mailer``
-MailPace            ``composer require symfony/mail-pace-mailer``
-Postmark            ``composer require symfony/postmark-mailer``
-SendGrid            ``composer require symfony/sendgrid-mailer``
-Sendinblue          ``composer require symfony/sendinblue-mailer``
-==================  ==============================================
+===================== ==============================================
+Service               Install with
+===================== ==============================================
+`Amazon SES`_         ``composer require symfony/amazon-mailer``
+`Infobip`_            ``composer require symfony/infobip-mailer``
+`MailChimp`_          ``composer require symfony/mailchimp-mailer``
+`Mailgun`_            ``composer require symfony/mailgun-mailer``
+`Mailjet`_            ``composer require symfony/mailjet-mailer``
+`MailPace`_           ``composer require symfony/mail-pace-mailer``
+`MailerSend`_         ``composer require symfony/mailersend-mailer``
+`Postmark`_           ``composer require symfony/postmark-mailer``
+`SendGrid`_           ``composer require symfony/sendgrid-mailer``
+`Sendinblue`_         ``composer require symfony/sendinblue-mailer``
+===================== ==============================================
 
 .. versionadded:: 6.2
 
@@ -169,21 +169,21 @@ transport, but you can force to use one:
 This table shows the full list of available DSN formats for each third
 party provider:
 
-==================== ==================================================== =========================================== ========================================
-Provider             SMTP                                                 HTTP                                        API
-==================== ==================================================== =========================================== ========================================
-Amazon SES           ses+smtp://USERNAME:PASSWORD@default                 ses+https://ACCESS_KEY:SECRET_KEY@default   ses+api://ACCESS_KEY:SECRET_KEY@default
-Google Gmail         gmail+smtp://USERNAME:APP-PASSWORD@default           n/a                                         n/a
-Mailchimp Mandrill   mandrill+smtp://USERNAME:PASSWORD@default            mandrill+https://KEY@default                mandrill+api://KEY@default
-Mailgun              mailgun+smtp://USERNAME:PASSWORD@default             mailgun+https://KEY:DOMAIN@default          mailgun+api://KEY:DOMAIN@default
-Mailjet              mailjet+smtp://ACCESS_KEY:SECRET_KEY@default         n/a                                         mailjet+api://ACCESS_KEY:SECRET_KEY@default?sandbox=false
-MailPace             mailpace+api://API_TOKEN@default                     n/a                                         mailpace+api://API_TOKEN@default
-Postmark             postmark+smtp://ID@default                           n/a                                         postmark+api://KEY@default
-Sendgrid             sendgrid+smtp://KEY@default                          n/a                                         sendgrid+api://KEY@default
-Sendinblue           sendinblue+smtp://USERNAME:PASSWORD@default          n/a                                         sendinblue+api://KEY@default
-Infobip              infobip+smtp://KEY@default                           n/a                                         infobip+api://KEY@BASE_URL
-MailerSend           mailersend+smtp://KEY@default                        n/a                                         mailersend+api://KEY@BASE_URL
-==================== ==================================================== =========================================== ========================================
+====================  ============================================  =========================================  ========================================
+Provider              SMTP                                          HTTP                                       API
+====================  ============================================  =========================================  ========================================
+`Amazon SES`_         ses+smtp://USERNAME:PASSWORD@default          ses+https://ACCESS_KEY:SECRET_KEY@default  ses+api://ACCESS_KEY:SECRET_KEY@default
+`Google Gmail`_       gmail+smtp://USERNAME:APP-PASSWORD@default    n/a                                        n/a
+`Infobip`_            infobip+smtp://KEY@default                    n/a                                        infobip+api://KEY@BASE_URL
+`Mailchimp Mandrill`_ mandrill+smtp://USERNAME:PASSWORD@default     mandrill+https://KEY@default               mandrill+api://KEY@default
+`MailerSend`_         mailersend+smtp://KEY@default                 n/a                                        mailersend+api://KEY@BASE_URL
+`Mailgun`_            mailgun+smtp://USERNAME:PASSWORD@default      mailgun+https://KEY:DOMAIN@default         mailgun+api://KEY:DOMAIN@default
+`Mailjet`_            mailjet+smtp://ACCESS_KEY:SECRET_KEY@default  n/a                                        mailjet+api://ACCESS_KEY:SECRET_KEY@default
+`MailPace`_           mailpace+api://API_TOKEN@default              n/a                                        mailpace+api://API_TOKEN@default
+`Postmark`_           postmark+smtp://ID@default                    n/a                                        postmark+api://KEY@default
+`Sendgrid`_           sendgrid+smtp://KEY@default                   n/a                                        sendgrid+api://KEY@default
+`Sendinblue`_         sendinblue+smtp://USERNAME:PASSWORD@default   n/a                                        sendinblue+api://KEY@default
+====================  ============================================  =========================================  ========================================
 
 .. versionadded:: 6.3
 
@@ -1783,16 +1783,27 @@ the :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\MailerAssertionsTrait`::
         }
     }
 
-.. _`high availability`: https://en.wikipedia.org/wiki/High_availability
-.. _`load balancing`: https://en.wikipedia.org/wiki/Load_balancing_(computing)
+.. _`Amazon SES`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Amazon/README.md
+.. _`App Password`: https://support.google.com/accounts/answer/185833
+.. _`default_socket_timeout`: https://www.php.net/manual/en/filesystem.configuration.php#ini.default-socket-timeout
+.. _`DKIM`: https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail
 .. _`download the foundation-emails.css file`: https://github.com/foundation/foundation-emails/blob/develop/dist/foundation-emails.css
+.. _`Google Gmail`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Google/README.md
+.. _`high availability`: https://en.wikipedia.org/wiki/High_availability
+.. _`Infobip`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Infobip/README.md
+.. _`Inky`: https://get.foundation/emails/docs/inky.html
 .. _`league/html-to-markdown`: https://github.com/thephpleague/html-to-markdown
+.. _`load balancing`: https://en.wikipedia.org/wiki/Load_balancing_(computing)
+.. _`MailChimp Mandrill`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Mailchimp/README.md
+.. _`MailerSend`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/MailerSend/README.md
+.. _`Mailgun`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Mailgun/README.md
+.. _`Mailjet`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Mailjet/README.md
 .. _`Markdown syntax`: https://commonmark.org/
-.. _`Inky`: https://get.foundation/emails/docs/inky.html
-.. _`S/MIME`: https://en.wikipedia.org/wiki/S/MIME
-.. _`DKIM`: https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail
+.. _`MailPace`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/MailPace/README.md
 .. _`OpenSSL PHP extension`: https://www.php.net/manual/en/book.openssl.php
 .. _`PEM encoded`: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail
-.. _`default_socket_timeout`: https://www.php.net/manual/en/filesystem.configuration.php#ini.default-socket-timeout
+.. _`Postmark`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Postmark/README.md
 .. _`RFC 3986`: https://www.ietf.org/rfc/rfc3986.txt
-.. _`App Password`: https://support.google.com/accounts/answer/185833
+.. _`S/MIME`: https://en.wikipedia.org/wiki/S/MIME
+.. _`SendGrid`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Sendgrid/README.md
+.. _`Sendinblue`: https://github.com/symfony/symfony/blob/{version}/src/Symfony/Component/Mailer/Bridge/Sendinblue/README.md
diff --git a/mercure.rst b/mercure.rst
@@ -615,7 +615,7 @@ Testing
 
 During unit testing it's usually not needed to send updates to Mercure.
 
-You can instead make use of the `MockHub` class::
+You can instead make use of the ``MockHub`` class::
 
     // tests/FunctionalTest.php
     namespace App\Tests\Unit\Controller;
diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst
@@ -1021,6 +1021,60 @@ a ``user_checker`` option to define the service used to perform those checks.
 
 Learn more about user checkers in :doc:`/security/user_checkers`.
 
+Required Badges
+~~~~~~~~~~~~~~~
+
+Firewalls can configure a list of required badges that must be present on the authenticated passport:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # config/packages/security.yaml
+        security:
+            # ...
+
+            firewalls:
+                main:
+                    # ...
+                    required_badges: ['CsrfTokenBadge', 'My\Badge']
+
+    .. code-block:: xml
+
+        <!-- config/packages/security.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <srv:container xmlns="http://symfony.com/schema/dic/security"
+            xmlns:srv="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                https://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/security
+                https://symfony.com/schema/dic/security/security-1.0.xsd">
+
+            <config>
+                <firewall name="main">
+                    <!-- ... -->
+                    <required_badge>CsrfTokenBadge</required_badge>
+                    <required_badge>My\Badge</required_badge>
+                </firewall>
+            </config>
+        </srv:container>
+
+    .. code-block:: php
+
+        // config/packages/security.php
+        use Symfony\Config\SecurityConfig;
+
+        return static function (SecurityConfig $security) {
+            $mainFirewall = $security->firewall('main');
+            $mainFirewall->requiredBadges(['CsrfTokenBadge', 'My\Badge']);
+            // ...
+        };
+
+.. versionadded:: 5.3
+
+    The ``required_badges`` option was introduced in Symfony 5.3.
+
 providers
 ---------
 
diff --git a/setup.rst b/setup.rst
@@ -144,7 +144,7 @@ the server by pressing ``Ctrl+C`` from your terminal.
 Symfony Docker Integration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If you'd like to use Docker with Symfony, see :doc:`setup/docker`
+If you'd like to use Docker with Symfony, see :doc:`/setup/docker`.
 
 .. _symfony-flex:
 
diff --git a/setup/symfony_server.rst b/setup/symfony_server.rst
@@ -65,8 +65,11 @@ run the Symfony server in the background:
 
     .. code-block:: terminal
 
-        # change the path to the location of your Symfony binary
-        $ sudo codesign --force --deep --sign - /opt/homebrew/Cellar/symfony-cli/5.4.21/bin/symfony
+        # find the installed version of the Symfony binary
+        $ symfony version
+
+        # change the path to the location of your Symfony binary and replace {version} too
+        $ sudo codesign --force --deep --sign - /opt/homebrew/Cellar/symfony-cli/{version}/bin/symfony
 
 Enabling PHP-FPM
 ----------------
