Merge pull request #213 from moufmouf/semver

Adding SemVer promise

Author: moufmouf

docs/semver.md

@@ -0,0 +1,48 @@
+---
+id: semver
+title: Our backward compatibility promise
+sidebar_label: Semantic versioning
+---
+
+Ensuring smooth upgrades of your project is a priority. That's why we promise you backward compatibility (BC) for all 
+minor GraphQLite releases. You probably recognize this strategy as [Semantic Versioning](https://semver.org/). In short, 
+Semantic Versioning means that only major releases (such as 4.0, 5.0 etc.) are allowed to break backward compatibility.
+Minor releases (such as 4.0, 4.1 etc.) may introduce new features, but must do so without breaking the existing API of 
+that release branch (4.x in the previous example).
+
+But sometimes, a new feature is not quite "dry" and we need a bit of time to find the perfect API.
+In such cases, we prefer to gather feedback from real-world usage, adapt the API, or remove it altogether.
+Doing so is not possible with a no BC-break approach.
+
+To avoid being bound to our backward compatibility promise, such features can be marked as **unstable** or **experimental** 
+and their classes and methods are marked with the `@unstable` or `@experimental` tag.
+
+`@unstable` or `@experimental` classes / methods will **not break** in a patch release, but *may be broken* in a minor version.
+
+As a rule of thumb:
+
+- If you are a GraphQLite user (using GraphQLite mainly through its annotations), we guarantee strict semantic versioning
+- If you are extending GraphQLite features (if you are developing custom annotations, or if you are developing a GraphQlite integration 
+  with a framework...), be sure to check the tags.
+
+Said otherwise:
+
+- If you are a GraphQLite user, in your `composer.json`, target a major version:
+  ```json
+  {
+    "require": {
+      "thecodingmachine/graphqlite": "^4"
+    }
+  }
+  ```
+- If you are extending the GraphQLite ecosystem, in your `composer.json`, target a minor version:
+  ```json
+  {
+    "require": {
+      "thecodingmachine/graphqlite": "~4.1.0"
+    }
+  }
+  ```
+
+Finally, classes / methods annotated with the `@internal` annotation are not meant to be used in your code or third-party library.
+They are meant for GraphQLite internal usage and they may break anytime. Do not use those directly.

src/Context/ContextInterface.php

@@ -9,6 +9,8 @@
 
 /**
  * A context class that should be passed to the Webonyx executor.
+ *
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
  */
 interface ContextInterface
 {

src/Mappers/CannotMapTypeExceptionInterface.php

@@ -11,6 +11,9 @@
 use TheCodingMachine\GraphQLite\Annotations\SourceFieldInterface;
 use Throwable;
 
+/**
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
+ */
 interface CannotMapTypeExceptionInterface extends Throwable
 {
     public function addParamInfo(ReflectionParameter $parameter): void;

src/Mappers/RecursiveTypeMapperInterface.php

@@ -18,6 +18,8 @@
  * Maps a PHP class to a GraphQL type.
  *
  * Unlike the TypeMapperInterface, if a given class does not map a type, parent classes are explored.
+ *
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
  */
 interface RecursiveTypeMapperInterface
 {

src/Mappers/TypeMapperInterface.php

@@ -15,6 +15,8 @@
 
 /**
  * Maps a PHP class to a GraphQL type
+ *
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
  */
 interface TypeMapperInterface
 {

src/Middlewares/FieldHandlerInterface.php

@@ -7,6 +7,9 @@
 use GraphQL\Type\Definition\FieldDefinition;
 use TheCodingMachine\GraphQLite\QueryFieldDescriptor;
 
+/**
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
+ */
 interface FieldHandlerInterface
 {
     /**

src/Middlewares/FieldMiddlewareInterface.php

@@ -9,6 +9,8 @@
 
 /**
  * A middleware use to process annotations when evaluating a field/query/mutation
+ *
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
  */
 interface FieldMiddlewareInterface
 {

src/NamingStrategyInterface.php

@@ -7,6 +7,9 @@
 use TheCodingMachine\GraphQLite\Annotations\Factory;
 use TheCodingMachine\GraphQLite\Annotations\Type;
 
+/**
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
+ */
 interface NamingStrategyInterface
 {
     /**

src/Parameters/InputTypeParameterInterface.php

@@ -7,6 +7,9 @@
 use GraphQL\Type\Definition\InputType;
 use GraphQL\Type\Definition\ResolveInfo;
 
+/**
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
+ */
 interface InputTypeParameterInterface extends ParameterInterface
 {
     /**

src/Parameters/ParameterInterface.php

@@ -8,6 +8,8 @@
 
 /**
  * Instances of ParameterInterface represent a single PHP parameter in a Query/Mutation/Field/Factory.
+ *
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
  */
 interface ParameterInterface
 {

src/Security/AuthenticationServiceInterface.php

@@ -4,6 +4,9 @@
 
 namespace TheCodingMachine\GraphQLite\Security;
 
+/**
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
+ */
 interface AuthenticationServiceInterface
 {
     /**

src/Security/AuthorizationServiceInterface.php

@@ -4,6 +4,9 @@
 
 namespace TheCodingMachine\GraphQLite\Security;
 
+/**
+ * @unstable See https://graphqlite.thecodingmachine.io/docs/semver.html
+ */
 interface AuthorizationServiceInterface
 {
     /**

website/sidebars.json

@@ -6,6 +6,6 @@
     "Security": ["authentication_authorization", "fine-grained-security", "implementing-security"],
     "Performance": ["query-plan", "prefetch-method"],
     "Advanced": ["file-uploads", "pagination", "custom-types", "field-middlewares", "argument-resolving", "extend_input_type", "multiple_output_types", "symfony-bundle-advanced", "laravel-package-advanced", "internals", "troubleshooting", "migrating"],
-    "Reference": ["annotations_reference", "changelog"]
+    "Reference": ["annotations_reference", "semver","changelog"]
   }
 }