Skip to content

Commit

Permalink
DevKit updates
Browse files Browse the repository at this point in the history
  • Loading branch information
SonataCI authored and jordisala1991 committed Aug 1, 2022
1 parent 8bf57ba commit 9d8eb86
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Bug.md
Original file line number Diff line number Diff line change
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/twig-extensions/blob/1.x/CONTRIBUTING.md#issues
More details here: https://github.com/sonata-project/twig-extensions/blob/2.x/CONTRIBUTING.md#issues
-->
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<!--
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
- 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/twig-extensions/blob/1.x/CONTRIBUTING.md#base-branch
- 2.x is for everything backwards compatible, like patches, features and deprecation notices
- 3.x is for deprecation removals and other changes that cannot be done without a BC-break
More details here: https://github.com/sonata-project/twig-extensions/blob/2.x/CONTRIBUTING.md#base-branch
-->
I am targeting this branch, because {reason}.

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
branches:
- 1.x
- 2.x
- 3.x
pull_request:

permissions:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
branches:
- 1.x
- 2.x
- 3.x
pull_request:

permissions:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/qa.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
branches:
- 1.x
- 2.x
- 3.x
pull_request:

permissions:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/symfony-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
branches:
- 1.x
- 2.x
- 3.x
pull_request:

permissions:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
branches:
- 1.x
- 2.x
- 3.x
pull_request:

permissions:
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,20 +219,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 | `1.x` | |
Bug fixes | No (Only if no choice) | Major | `2.x` | |
Feature | Yes | Minor | `1.x` | |
Feature | No (Only if no choice) | Major | `2.x` | |
Deprecation | Yes (Have to) | Minor | `1.x` | |
Deprecation removal | No (Can't be) | Major | `2.x` | |
Bug fixes | Yes | Patch | `2.x` | |
Bug fixes | No (Only if no choice) | Major | `3.x` | |
Feature | Yes | Minor | `2.x` | |
Feature | No (Only if no choice) | Major | `3.x` | |
Deprecation | Yes (Have to) | Minor | `2.x` | |
Deprecation removal | No (Can't be) | Major | `3.x` | |

Notes:
* Branch `1.x` is the branch of the **latest stable** minor release and
* Branch `2.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 `2.x` branch which removes the deprecated code.
* If your BC PR is accepted, you can do a new one on the `3.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
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Sonata twig extensions

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] |
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] |
2.x | [![Test][test_stable_badge]][test_stable_link] | [![Coverage Status][coverage_stable_badge]][coverage_stable_link] | [![Documentation Status][documentation_stable_badge]][documentation_stable_link] |
3.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/twig-extensions/workflows/Test/badge.svg?branch=1.x
[test_stable_link]: https://github.com/sonata-project/twig-extensions/actions?query=workflow:test+branch:1.x
[test_unstable_badge]: https://github.com/sonata-project/twig-extensions/workflows/Test/badge.svg?branch=2.x
[test_unstable_link]: https://github.com/sonata-project/twig-extensions/actions?query=workflow:test+branch:2.x
[coverage_stable_badge]: https://codecov.io/gh/sonata-project/twig-extensions/branch/1.x/graph/badge.svg
[coverage_stable_link]: https://codecov.io/gh/sonata-project/twig-extensions/branch/1.x
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/twig-extensions/branch/2.x/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/twig-extensions/branch/2.x
[test_stable_badge]: https://github.com/sonata-project/twig-extensions/workflows/Test/badge.svg?branch=2.x
[test_stable_link]: https://github.com/sonata-project/twig-extensions/actions?query=workflow:test+branch:2.x
[test_unstable_badge]: https://github.com/sonata-project/twig-extensions/workflows/Test/badge.svg?branch=3.x
[test_unstable_link]: https://github.com/sonata-project/twig-extensions/actions?query=workflow:test+branch:3.x
[coverage_stable_badge]: https://codecov.io/gh/sonata-project/twig-extensions/branch/2.x/graph/badge.svg
[coverage_stable_link]: https://codecov.io/gh/sonata-project/twig-extensions/branch/2.x
[coverage_unstable_badge]: https://codecov.io/gh/sonata-project/twig-extensions/branch/3.x/graph/badge.svg
[coverage_unstable_link]: https://codecov.io/gh/sonata-project/twig-extensions/branch/3.x
[shepherd_stable_badge]: https://shepherd.dev/github/sonata-project/twig-extensions/coverage.svg
[shepherd_stable_link]: https://shepherd.dev/github/sonata-project/twig-extensions
[documentation_stable_badge]: https://readthedocs.org/projects/sonata-project-twig-extensions/badge/?version=1.x
[documentation_stable_link]: https://docs.sonata-project.org/projects/twig-extensions/en/1.x/?badge=1.x
[documentation_unstable_badge]: https://readthedocs.org/projects/sonata-project-twig-extensions/badge/?version=2.x
[documentation_unstable_link]: https://docs.sonata-project.org/projects/twig-extensions/en/2.x/?badge=2.x
[documentation_stable_badge]: https://readthedocs.org/projects/sonata-project-twig-extensions/badge/?version=2.x
[documentation_stable_link]: https://docs.sonata-project.org/projects/twig-extensions/en/2.x/?badge=2.x
[documentation_unstable_badge]: https://readthedocs.org/projects/sonata-project-twig-extensions/badge/?version=3.x
[documentation_unstable_link]: https://docs.sonata-project.org/projects/twig-extensions/en/3.x/?badge=3.x
2 changes: 1 addition & 1 deletion docs/.doctor-rst.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ rules:

whitelist:
lines:
- '.. versionadded:: 1.x'
- '.. versionadded:: 2.x'

0 comments on commit 9d8eb86

Please sign in to comment.