@@ -188,7 +188,7 @@ Create an entry in ``"recipes"`` for each of your bundle recipes. Replace
188
188
with your own details.
189
189
190
190
Generate Recipes from a Developer Friendly Format Using the Recipes Checker
191
- --------------
191
+ ---------------------------------------------------------------------------
192
192
193
193
When installing a bundle, composer checks for flex recipes in the format
194
194
stated in the above sections, this is cumbersome to write by hand.
@@ -226,15 +226,18 @@ Be sure to change ``acme``, ``private-bundle`` and ``1.0`` to your bundle detail
226
226
.. warning ::
227
227
228
228
Please note that bundle version number **must ** be in the **{major}.{minor} ** format
229
- (eg . **don't ** use ``1.0.0 `` but instead ``1.0 ``)
229
+ (e.g . **don't ** use ``1.0.0 `` but instead ``1.0 ``)
230
230
231
231
.. note ::
232
+
232
233
The only thing you need in the ``1.0 `` directory is a valid ``manifest.json ``.
233
234
Other things are optional and you can read more about it in the official
234
235
`symfony recipes repository `_
235
236
236
237
You can then create a simplified ``manifest.json ``, for example:
238
+
237
239
.. code-block :: json
240
+
238
241
{
239
242
"bundles" : {
240
243
"Acme\\ PrivateBundle\\ AcmePrivateBundle" : [" all" ]
@@ -246,11 +249,14 @@ You can then create a simplified ``manifest.json``, for example:
246
249
}
247
250
248
251
.. note ::
252
+
249
253
Every configurator in the ``manifest.json `` file is optional,
250
254
you can find the full list `here `_
251
255
252
256
You are now ready to generate target recipe files by executing the following command in your recipes root directory:
257
+
253
258
.. code-block :: terminal
259
+
254
260
$ git ls-tree HEAD */*/* | /path/to/recipes-checker-directory/run generate:flex-endpoint acme/private-bundle source-branch target-branch ./output/
255
261
256
262
Where:
@@ -372,7 +378,9 @@ Replace ``your-gitlab-project-id`` with your own details.
372
378
The ``extra.symfony `` key will most probably already exist in your
373
379
``composer.json ``. In that case, add the ``"endpoint" `` key to the existing
374
380
``extra.symfony `` entry.
381
+
375
382
.. tip ::
383
+
376
384
Note that when using recipes checker
377
385
your endpoint **must ** point to the branch with compiled recipes with a ``ref `` query
378
386
parameter or by setting it as a default branch
0 commit comments