Skip to content
This repository has been archived by the owner on Jul 22, 2022. It is now read-only.

Commit

Permalink
DevKit updates (#308)
Browse files Browse the repository at this point in the history
  • Loading branch information
SonataCI committed Sep 20, 2021
1 parent 4fb19b6 commit 0854284
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Show us you choose the right branch.
Different branches are used for different things :
- 1.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
- 2.x is for deprecation removals and other changes that cannot be done without a BC-break
More details here: https://github.com/sonata-project/SonataAdminSearchBundle/blob/1.x/CONTRIBUTING.md#base-branch
-->
I am targeting this branch, because {reason}.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 1.x
- master
- 2.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 1.x
- master
- 2.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 1.x
- master
- 2.x
pull_request:

jobs:
Expand Down
6 changes: 3 additions & 3 deletions .symfony.bundle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@

branches:
- 1.x
- master
- 2.x

maintained_branches:
- 1.x
- master
- 2.x

doc_dir: 'docs/'

current_branch: 1.x

dev_branch: master
dev_branch: 2.x

# dev_branch_alias:
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
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 | `1.x` | |
Bug fixes | No (Only if no choice) | Major | `master` | |
Bug fixes | No (Only if no choice) | Major | `2.x` | |
Feature | Yes | Minor | `1.x` | |
Feature | No (Only if no choice) | Major | `master` | |
Feature | No (Only if no choice) | Major | `2.x` | |
Deprecation | Yes (Have to) | Minor | `1.x` | |
Deprecation removal | No (Can't be) | Major | `master` | |
Deprecation removal | No (Can't be) | Major | `2.x` | |

Notes:
* Branch `1.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 `2.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
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Implement Search Engine (ElasticSearch) inside Sonata Admin
Branch | Github Actions | Code Coverage | Documentation |
------ | -------------- | ------------- | ------------- |
1.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] |
2.x | [![Test][test_unstable_badge]][test_unstable_link] | [![Coverage Status][coverage_unstable_badge]][coverage_unstable_link] | [![Documentation Status][documentation_unstable_badge]][documentation_unstable_link] |

## WARNING: This repository is abandoned

Expand All @@ -44,15 +44,15 @@ This package is available under the [MIT license](LICENSE).

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

[coverage_stable_badge]: https://codecov.io/gh/sonata-project/SonataAdminSearchBundle/branch/1.x/graph/badge.svg
[coverage_stable_link]: https://codecov.io/gh/sonata-project/SonataAdminSearchBundle/branch/1.x
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/SonataAdminSearchBundle/branch/master/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataAdminSearchBundle/branch/master
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/SonataAdminSearchBundle/branch/2.x/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataAdminSearchBundle/branch/2.x

[documentation_stable_badge]: https://readthedocs.org/projects/sonataadminsearchbundle/badge/?version=1.x
[documentation_stable_link]: https://docs.sonata-project.org/projects/SonataAdminSearchBundle/en/1.x/?badge=1.x
[documentation_unstable_badge]: https://readthedocs.org/projects/sonataadminsearchbundle/badge/?version=master
[documentation_unstable_link]: https://docs.sonata-project.org/projects/SonataAdminSearchBundle/en/master/?badge=master
[documentation_unstable_badge]: https://readthedocs.org/projects/sonataadminsearchbundle/badge/?version=2.x
[documentation_unstable_link]: https://docs.sonata-project.org/projects/SonataAdminSearchBundle/en/2.x/?badge=2.x

0 comments on commit 0854284

Please sign in to comment.