Skip to content

Commit e629877

Browse files
authoredMar 7, 2025
docs(4.x): update references from master to 4.x (#2453)
## Description Follow-up on #2433 for `4.x` (previously called `master`) ## What type of PR is this? (check all applicable) - [ ] Bug Fix - [ ] Feature - [x] Refactor - [ ] Deprecation - [ ] Breaking Change - [x] Documentation Update - [x] CI ## Checklist - [ ] I have made corresponding changes to the documentation (`docs/`) - [ ] I have made corresponding changes to the changelog (`CHANGELOG.md`)
1 parent 5972e02 commit e629877

7 files changed

+14
-17
lines changed
 

‎.github/workflows/continuous-integration.yml

-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ on:
77
pull_request:
88
branches:
99
- "*.x"
10-
- master
1110
push:
1211
branches:
1312
- "*.x"
14-
- master
1513

1614
env:
1715
fail-fast: true

‎.symfony.bundle.yaml

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
branches: ["2.x", "3.x", "master", "5.x"]
2-
maintained_branches: ["master", "5.x"]
3-
current_branch: "master"
4-
master_alias: "4.x"
1+
branches: ["2.x", "3.x", "4.x", "5.x"]
2+
maintained_branches: ["4.x", "5.x"]
3+
current_branch: "4.x"
54
dev_branch: "5.x"
6-
doc_dir: { "3.x": "Resources/doc/", "master": "docs/", "5.x": "docs/" }
5+
doc_dir: { "3.x": "Resources/doc/", "4.x": "docs/", "5.x": "docs/" }

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
NelmioApiDocBundle
22
==================
33

4-
[![Build Status](https://img.shields.io/github/actions/workflow/status/nelmio/NelmioApiDocBundle/continuous-integration.yml?branch=master&style=flat-square)](https://github.com/nelmio/NelmioApiDocBundle/actions?query=workflow:CI)
5-
[![Codecov](https://img.shields.io/codecov/c/github/nelmio/NelmioApiDocBundle?branch=master&style=flat-square)](https://app.codecov.io/gh/nelmio/NelmioApiDocBundle)
4+
[![Build Status](https://img.shields.io/github/actions/workflow/status/nelmio/NelmioApiDocBundle/continuous-integration.yml?branch=4.x&style=flat-square)](https://github.com/nelmio/NelmioApiDocBundle/actions?query=workflow:CI)
5+
[![Codecov](https://img.shields.io/codecov/c/github/nelmio/NelmioApiDocBundle?branch=4.x&style=flat-square)](https://app.codecov.io/gh/nelmio/NelmioApiDocBundle)
66
[![Total Downloads](https://img.shields.io/packagist/dt/nelmio/api-doc-bundle?style=flat-square)](https://packagist.org/packages/nelmio/api-doc-bundle)
77
[![Latest Stable Version](https://img.shields.io/packagist/v/nelmio/api-doc-bundle?label=stable&style=flat-square)](https://packagist.org/packages/nelmio/api-doc-bundle)
88
[![PHP Version](https://img.shields.io/packagist/dependency-v/nelmio/api-doc-bundle/PHP?style=flat-square)](https://packagist.org/packages/nelmio/api-doc-bundle)
@@ -12,13 +12,13 @@ for your APIs.
1212

1313
## Migrate from 3.x to 4.0
1414

15-
[To migrate from 3.x to 4.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md)
15+
[To migrate from 3.x to 4.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/4.x/UPGRADE-4.0.md)
1616

1717
Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.
1818

1919
## Migrate from 2.x to 3.0
2020

21-
[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md)
21+
[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/4.x/UPGRADE-3.0.md)
2222

2323
## Installation
2424

@@ -35,7 +35,7 @@ composer require nelmio/api-doc-bundle
3535
## Contributing
3636

3737
See
38-
[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/master/CONTRIBUTING.md)
38+
[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/4.x/CONTRIBUTING.md)
3939
file.
4040

4141
## Running the Tests

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
},
9494
"extra": {
9595
"branch-alias": {
96-
"dev-master": "4.x-dev"
96+
"dev-4.x": "4.x-dev"
9797
}
9898
},
9999
"scripts-descriptions": {

‎docs/customization.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Just create a file ``templates/bundles/NelmioApiDocBundle/SwaggerUi/index.html.t
6868
<script type="text/javascript" src="{{ asset('js/custom-request-signer.js') }}"></script>
6969
{% endblock javascripts %}
7070
71-
You can have a look at the `original template <https://github.com/nelmio/NelmioApiDocBundle/blob/master/templates/SwaggerUi/index.html.twig>`_, in ``/templates/SwaggerUi/index.html.twig``, to see which blocks can be overridden.
71+
You can have a look at the `original template <https://github.com/nelmio/NelmioApiDocBundle/blob/4.x/templates/SwaggerUi/index.html.twig>`_, in ``/templates/SwaggerUi/index.html.twig``, to see which blocks can be overridden.
7272

7373
Assets Loading Options
7474
-----------------------
@@ -85,7 +85,7 @@ The `html_config` settings allow you to configure how assets are loaded for the
8585
`assets_mode`
8686
~~~~~~~~~~~~~
8787

88-
The three values possible values can be found in `AssetsMode.php <https://github.com/nelmio/NelmioApiDocBundle/blob/master/src/Render/Html/AssetsMode.php>`_
88+
The three values possible values can be found in `AssetsMode.php <https://github.com/nelmio/NelmioApiDocBundle/blob/4.x/src/Render/Html/AssetsMode.php>`_
8989
- **cdn**: Loads assets from `jsDelivr <https://www.jsdelivr.com/>`_.
9090
- **bundle**: Fetches assets from the bundle in the vendor directory, including updates.
9191
- **offline**: Loads assets from the local `assets` directory, requiring the developer to update them manually.

‎docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Migrate from 3.x to 4.0
2424

2525
`To migrate from 3.x to 4.0, follow our guide.`__
2626

27-
__ https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md
27+
__ https://github.com/nelmio/NelmioApiDocBundle/blob/4.x/UPGRADE-4.0.md
2828

2929
Installation
3030
------------

‎docs/symfony_attributes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,4 +237,4 @@ Make sure to use at least php 8.1 (attribute support) to make use of this functi
237237
.. _`Symfony MapQueryParameter`: https://symfony.com/doc/current/controller.html#mapping-query-parameters-individually
238238
.. _`Symfony MapRequestPayload`: https://symfony.com/doc/current/controller.html#mapping-request-payload
239239
.. _`Symfony MapUploadedFile`: https://symfony.com/doc/current/controller.html#mapping-uploaded-files
240-
.. _`RouteArgumentDescriberInterface`: https://github.com/DjordyKoert/NelmioApiDocBundle/blob/master/src/RouteDescriber/RouteArgumentDescriber/RouteArgumentDescriberInterface.php
240+
.. _`RouteArgumentDescriberInterface`: https://github.com/DjordyKoert/NelmioApiDocBundle/blob/4.x/src/RouteDescriber/RouteArgumentDescriber/RouteArgumentDescriberInterface.php

0 commit comments

Comments
 (0)