Skip to content

Commit

Permalink
DevKit updates (#671)
Browse files Browse the repository at this point in the history
  • Loading branch information
SonataCI committed Sep 18, 2021
1 parent fd91937 commit 68b48ba
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -7,7 +7,7 @@
Show us you choose the right branch.
Different branches are used for different things :
- 4.x is for everything backwards compatible, like patches, features and deprecation notices
- master is for deprecation removals and other changes that cannot be done without a BC-break
- 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/SonataDoctrineMongoDBAdminBundle/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,7 +9,7 @@ on:
branches:
- 3.x
- 4.x
- master
- 5.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Expand Up @@ -9,7 +9,7 @@ on:
branches:
- 3.x
- 4.x
- master
- 5.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/qa.yaml
Expand Up @@ -9,7 +9,7 @@ on:
branches:
- 3.x
- 4.x
- master
- 5.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Expand Up @@ -9,7 +9,7 @@ on:
branches:
- 3.x
- 4.x
- master
- 5.x
pull_request:

jobs:
Expand Down
6 changes: 3 additions & 3 deletions .symfony.bundle.yaml
Expand Up @@ -5,17 +5,17 @@
branches:
- 3.x
- 4.x
- master
- 5.x

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

doc_dir: 'docs/'

current_branch: 4.x

dev_branch: master
dev_branch: 5.x

# dev_branch_alias:
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Expand Up @@ -216,19 +216,19 @@ 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 | `4.x` | |
Bug fixes | No (Only if no choice) | Major | `master` | |
Bug fixes | No (Only if no choice) | Major | `5.x` | |
Feature | Yes | Minor | `4.x` | |
Feature | No (Only if no choice) | Major | `master` | |
Feature | No (Only if no choice) | Major | `5.x` | |
Deprecation | Yes (Have to) | Minor | `4.x` | |
Deprecation removal | No (Can't be) | Major | `master` | |
Deprecation removal | No (Can't be) | Major | `5.x` | |

Notes:
* 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 `master` 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
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -20,7 +20,7 @@ Symfony Sonata / Integrate Doctrine MongoDB ODM into the SonataAdminBundle
Branch | Github Actions | Code Coverage | Documentation |
------ | -------------- | ------------- | ------------- |
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] |
master | [![Test][test_unstable_badge]][test_unstable_link] | [![Coverage Status][coverage_unstable_badge]][coverage_unstable_link] | [![Documentation Status][documentation_unstable_badge]][documentation_unstable_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 @@ -39,17 +39,17 @@ This package is available under the [MIT license](LICENSE).

[test_stable_badge]: https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle/workflows/Test/badge.svg?branch=4.x
[test_stable_link]: https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle/actions?query=workflow:test+branch:4.x
[test_unstable_badge]: https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle/workflows/Test/badge.svg?branch=master
[test_unstable_link]: https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle/actions?query=workflow:test+branch:master
[test_unstable_badge]: https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle/workflows/Test/badge.svg?branch=5.x
[test_unstable_link]: https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle/actions?query=workflow:test+branch:5.x

[coverage_stable_badge]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/4.x/graph/badge.svg
[coverage_stable_link]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/4.x
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/master/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/master
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/5.x/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/5.x
[shepherd_stable_badge]: https://shepherd.dev/github/sonata-project/SonataDoctrineMongoDBAdminBundle/coverage.svg
[shepherd_stable_link]: https://shepherd.dev/github/sonata-project/SonataDoctrineMongoDBAdminBundle

[documentation_stable_badge]: https://readthedocs.org/projects/sonatadoctrinemongodbadminbundle/badge/?version=4.x
[documentation_stable_link]: https://docs.sonata-project.org/projects/SonataDoctrineMongoDBAdminBundle/en/4.x/?badge=4.x
[documentation_unstable_badge]: https://readthedocs.org/projects/sonatadoctrinemongodbadminbundle/badge/?version=master
[documentation_unstable_link]: https://docs.sonata-project.org/projects/SonataDoctrineMongoDBAdminBundle/en/master/?badge=master
[documentation_unstable_badge]: https://readthedocs.org/projects/sonatadoctrinemongodbadminbundle/badge/?version=5.x
[documentation_unstable_link]: https://docs.sonata-project.org/projects/SonataDoctrineMongoDBAdminBundle/en/5.x/?badge=5.x

0 comments on commit 68b48ba

Please sign in to comment.