Skip to content

Commit

Permalink
DevKit updates for 4.x branch (#1646)
Browse files Browse the repository at this point in the history
* DevKit updates

* DevKit updates

* Fix psalm

Co-authored-by: Vincent Langlet <vincentlanglet@hotmail.fr>
  • Loading branch information
SonataCI and VincentLanglet committed Dec 3, 2022
1 parent 54f7b16 commit 94a5a68
Show file tree
Hide file tree
Showing 14 changed files with 44 additions and 37 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Expand Up @@ -2,4 +2,4 @@
#
# It's auto-generated by sonata-project/dev-kit package.

github: [core23, OskarStark, greg0ire, VincentLanglet]
github: [jordisala1991, core23, OskarStark, greg0ire]
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Bug.md
Expand Up @@ -68,5 +68,5 @@ $ php -v
If it's an error message or piece of code, use code block tags,
and make sure you provide the whole stack trace(s),
not just the first error message you can see.
More details here: https://github.com/sonata-project/SonataPageBundle/blob/3.x/CONTRIBUTING.md#issues
More details here: https://github.com/sonata-project/SonataPageBundle/blob/4.x/CONTRIBUTING.md#issues
-->
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -6,9 +6,9 @@
<!--
Show us you choose the right branch.
Different branches are used for different things :
- 3.x is for everything backwards compatible, like patches, features and deprecation notices
- 4.x is for deprecation removals and other changes that cannot be done without a BC-break
More details here: https://github.com/sonata-project/SonataPageBundle/blob/3.x/CONTRIBUTING.md#base-branch
- 4.x is for everything backwards compatible, like patches, features and deprecation notices
- 5.x is for deprecation removals and other changes that cannot be done without a BC-break
More details here: https://github.com/sonata-project/SonataPageBundle/blob/4.x/CONTRIBUTING.md#base-branch
-->
I am targeting this branch, because {reason}.

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yaml
Expand Up @@ -9,8 +9,8 @@ on:
- cron: '30 0 * * *'
push:
branches:
- 3.x
- 4.x
- 5.x
pull_request:

permissions:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/frontend.yaml
Expand Up @@ -10,6 +10,7 @@ on:
push:
branches:
- 4.x
- 5.x
pull_request:

permissions:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Expand Up @@ -9,8 +9,8 @@ on:
- cron: '30 0 * * *'
push:
branches:
- 3.x
- 4.x
- 5.x
pull_request:

permissions:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/qa.yaml
Expand Up @@ -9,8 +9,8 @@ on:
- cron: '30 0 * * *'
push:
branches:
- 3.x
- 4.x
- 5.x
pull_request:

permissions:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/symfony-lint.yaml
Expand Up @@ -9,8 +9,8 @@ on:
- cron: '30 0 * * *'
push:
branches:
- 3.x
- 4.x
- 5.x
pull_request:

permissions:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Expand Up @@ -9,8 +9,8 @@ on:
- cron: '30 0 * * *'
push:
branches:
- 3.x
- 4.x
- 5.x
pull_request:

permissions:
Expand Down
8 changes: 4 additions & 4 deletions .symfony.bundle.yaml
Expand Up @@ -3,17 +3,17 @@
# It's auto-generated by sonata-project/dev-kit package.

branches:
- 3.x
- 4.x
- 5.x

maintained_branches:
- 3.x
- 4.x
- 5.x

doc_dir: 'docs/'

current_branch: 3.x
current_branch: 4.x

dev_branch: 4.x
dev_branch: 5.x

# dev_branch_alias:
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Expand Up @@ -283,20 +283,20 @@ Here is a short table resuming on which you have to start:

Kind of modification | Backward Compatible (BC) | Type of release | Branch to target | Label |
-------------------- | ------------------------ | --------------- | ----------------------- | ----- |
Bug fixes | Yes | Patch | `3.x` | |
Bug fixes | No (Only if no choice) | Major | `4.x` | |
Feature | Yes | Minor | `3.x` | |
Feature | No (Only if no choice) | Major | `4.x` | |
Deprecation | Yes (Have to) | Minor | `3.x` | |
Deprecation removal | No (Can't be) | Major | `4.x` | |
Bug fixes | Yes | Patch | `4.x` | |
Bug fixes | No (Only if no choice) | Major | `5.x` | |
Feature | Yes | Minor | `4.x` | |
Feature | No (Only if no choice) | Major | `5.x` | |
Deprecation | Yes (Have to) | Minor | `4.x` | |
Deprecation removal | No (Can't be) | Major | `5.x` | |

Notes:
* Branch `3.x` is the branch of the **latest stable** minor release and
* Branch `4.x` is the branch of the **latest stable** minor release and
has to be used for Backward compatible PRs.
* If you PR is not **Backward Compatible** but can be, it **MUST** be:
* Changing a function/method signature? Prefer create a new one and deprecate the old one.
* Code deletion? Don't. Please deprecate it instead.
* If your BC PR is accepted, you can do a new one on the `4.x` branch which removes the deprecated code.
* If your BC PR is accepted, you can do a new one on the `5.x` branch which removes the deprecated code.
* SYMFONY DOC REF (same logic)?

If you have a non-BC PR to propose, please try to create a related BC PR first.
Expand Down
28 changes: 14 additions & 14 deletions README.md
Expand Up @@ -19,8 +19,8 @@ This bundle provides a Site and Page management through container and block serv

Branch | Github Actions | Code Coverage | Documentation |
------ | -------------- | ------------- | ------------- |
3.x | [![Test][test_stable_badge]][test_stable_link] | [![Coverage Status][coverage_stable_badge]][coverage_stable_link] | [![Documentation Status][documentation_stable_badge]][documentation_stable_link] |
4.x | [![Test][test_unstable_badge]][test_unstable_link] | [![Coverage Status][coverage_unstable_badge]][coverage_unstable_link] | [![Documentation Status][documentation_unstable_badge]][documentation_unstable_link] |
4.x | [![Test][test_stable_badge]][test_stable_link] | [![Coverage Status][coverage_stable_badge]][coverage_stable_link] | [![Documentation Status][documentation_stable_badge]][documentation_stable_link] |
5.x | [![Test][test_unstable_badge]][test_unstable_link] | [![Coverage Status][coverage_unstable_badge]][coverage_unstable_link] | [![Documentation Status][documentation_unstable_badge]][documentation_unstable_link] |

## Documentation

Expand All @@ -37,17 +37,17 @@ If you think you found a bug or you have a feature idea to propose, feel free to

This package is available under the [MIT license](LICENSE).

[test_stable_badge]: https://github.com/sonata-project/SonataPageBundle/workflows/Test/badge.svg?branch=3.x
[test_stable_link]: https://github.com/sonata-project/SonataPageBundle/actions?query=workflow:test+branch:3.x
[test_unstable_badge]: https://github.com/sonata-project/SonataPageBundle/workflows/Test/badge.svg?branch=4.x
[test_unstable_link]: https://github.com/sonata-project/SonataPageBundle/actions?query=workflow:test+branch:4.x
[coverage_stable_badge]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/3.x/graph/badge.svg
[coverage_stable_link]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/3.x
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/4.x/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/4.x
[test_stable_badge]: https://github.com/sonata-project/SonataPageBundle/workflows/Test/badge.svg?branch=4.x
[test_stable_link]: https://github.com/sonata-project/SonataPageBundle/actions?query=workflow:test+branch:4.x
[test_unstable_badge]: https://github.com/sonata-project/SonataPageBundle/workflows/Test/badge.svg?branch=5.x
[test_unstable_link]: https://github.com/sonata-project/SonataPageBundle/actions?query=workflow:test+branch:5.x
[coverage_stable_badge]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/4.x/graph/badge.svg
[coverage_stable_link]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/4.x
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/5.x/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataPageBundle/branch/5.x
[shepherd_stable_badge]: https://shepherd.dev/github/sonata-project/SonataPageBundle/coverage.svg
[shepherd_stable_link]: https://shepherd.dev/github/sonata-project/SonataPageBundle
[documentation_stable_badge]: https://readthedocs.org/projects/sonatapagebundle/badge/?version=3.x
[documentation_stable_link]: https://docs.sonata-project.org/projects/SonataPageBundle/en/3.x/?badge=3.x
[documentation_unstable_badge]: https://readthedocs.org/projects/sonatapagebundle/badge/?version=4.x
[documentation_unstable_link]: https://docs.sonata-project.org/projects/SonataPageBundle/en/4.x/?badge=4.x
[documentation_stable_badge]: https://readthedocs.org/projects/sonatapagebundle/badge/?version=4.x
[documentation_stable_link]: https://docs.sonata-project.org/projects/SonataPageBundle/en/4.x/?badge=4.x
[documentation_unstable_badge]: https://readthedocs.org/projects/sonatapagebundle/badge/?version=5.x
[documentation_unstable_link]: https://docs.sonata-project.org/projects/SonataPageBundle/en/5.x/?badge=5.x
2 changes: 1 addition & 1 deletion docs/.doctor-rst.yaml
Expand Up @@ -43,5 +43,5 @@ rules:

whitelist:
lines:
- '.. versionadded:: 3.x'
- '.. versionadded:: 4.x'
- 'resource: "@NelmioApiDocBundle/Resources/config/routing.yml"'
6 changes: 6 additions & 0 deletions psalm.xml
Expand Up @@ -24,5 +24,11 @@
<InternalClass errorLevel="suppress"/>
<InternalMethod errorLevel="suppress"/>
<InternalProperty errorLevel="suppress"/>
<UndefinedInterfaceMethod>
<errorLevel type="suppress">
<!-- https://github.com/psalm/psalm-plugin-symfony/issues/287 -->
<referencedMethod name="Symfony\Component\Console\Helper\HelperInterface::ask"/>
</errorLevel>
</UndefinedInterfaceMethod>
</issueHandlers>
</psalm>

0 comments on commit 94a5a68

Please sign in to comment.