Release v0.3.0

Author: Josh Price

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.3.0 (2016-05-29)
+
+* Enhancements
+  * Directive support (@skip and @include)
+  * Validations now run on queries
+    * Rule: Fields on correct type
+    * Rule: No fragment cycles
+    * Rule: Validate mandatory arguments
+    * Rule: Unique operation names
+
+* Bugfixes
+  * Allow default values to get assigned correctly when a query defines
+    an enum variable with a default
+  * Query can take an optional Enum argument and correctly fall back if
+    that value is not specified
+
+* Note: the `execute/5` signature will be changed to the `execute_with_opts/3`
+  in a future version
+
 ## 0.2.0 (2016-03-19)
 
 * Enhancements

README.md

@@ -20,7 +20,7 @@ First, add GraphQL to your `mix.exs` dependencies:
 
 ```elixir
 defp deps do
-  [{:graphql, "~> 0.2"}]
+  [{:graphql, "~> 0.3"}]
 end
 ```
 

RELEASE.md

@@ -0,0 +1,36 @@
+# Release process
+
+This document simply outlines the release process:
+
+1. Ensure you are running on the oldest supported Elixir version (check `.travis.yml`)
+
+2. Ensure `CHANGELOG.md` is updated and add current date
+
+3. Change the version number in `mix.exs` and `README.md`
+
+4. Run `mix test` to ensure all tests pass
+
+5. Commit changes above with title "Release vVERSION" and push to GitHub
+
+    git add .
+    git commit -m"Release vX.Y.Z"
+    git push origin master
+
+6. Check CI is green
+
+7. Create a release on GitHub and add the CHANGELOG from step #2 (https://github.com/graphql-elixir/graphql/releases/new) using VERSION as the tag and title
+
+8. Publish new hex release with `mix hex.publish`
+
+9. Publish hex docs with `mix hex.docs`
+
+
+## Deprecation policy
+
+GraphQL deprecations happen in 3 steps:
+
+  1. The feature is soft-deprecated. It means both CHANGELOG and documentation must list the feature as deprecated but no warning is effectively emitted by running the code. There is no requirement to soft-deprecate a feature.
+
+  2. The feature is effectively deprecated by emitting warnings on usage. In order to deprecate a feature, the proposed alternative MUST exist for AT LEAST two versions.
+
+  3. The feature is removed. This can only happen on major releases.

lib/graphql.ex

@@ -59,9 +59,10 @@ defmodule GraphQL do
 
       # iex> GraphQL.execute_with_opts(schema, "{ hello }")
       # {:ok, %{hello: world}}
+
+  This is the preferred function signature for `execute` and
+  will replace `execute/5`.
   """
-  # FIXME: when the execute/5 form is removed (after updating the plug)
-  # then rename this to `execute`.
   def execute_with_opts(schema, query, opts \\ []) do
     execute_with_optional_validation(schema, query, opts)
   end
@@ -71,8 +72,10 @@ defmodule GraphQL do
 
       # iex> GraphQL.execute(schema, "{ hello }")
       # {:ok, %{hello: world}}
+
+  *Deprecation warning*: This will be replaced in a future version with the
+  function signature for `execute_with_opts/3`.
   """
-  # TODO: delete this when a new plug is released.
   def execute(schema, query, root_value \\ %{}, variable_values \\ %{}, operation_name \\ nil) do
     execute_with_optional_validation(
       schema,

mix.exs

@@ -1,7 +1,7 @@
 defmodule GraphQL.Mixfile do
   use Mix.Project
 
-  @version "0.2.0"
+  @version "0.3.0"
 
   @description "GraphQL Elixir implementation"
   @repo_url "https://github.com/graphql-elixir/graphql"
@@ -42,7 +42,7 @@ defmodule GraphQL.Mixfile do
   end
 
   defp package do
-    [maintainers: ["Josh Price", "James Sadler", "Mark Olson", "Aaron Weiker"],
+    [maintainers: ["Josh Price", "James Sadler", "Mark Olson", "Aaron Weiker", "Sean Abrahams"],
      licenses: ["BSD"],
      links: %{"GitHub" => @repo_url},
      files: ~w(lib src/*.xrl src/*.yrl mix.exs *.md LICENSE)]