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

Commit

Permalink
Release v0.3.1
Browse files Browse the repository at this point in the history
Also add `RELEASE.md` to mirror the release process in GraphQL core
  • Loading branch information
Josh Price committed Jun 1, 2016
1 parent d8fb53d commit c9d2763
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 2 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## 0.3.1 (2016-05-30)

* Enhancements
* Upgrade to GraphiQL 0.7.1

* Bugfixes
* Fix GraphiQL bug where GraphQL server was assumed to be mounted at `/graphql`

## 0.3.0 (2016-05-30)

* Enhancements
* Upgrade to GraphQL 0.3.0
* Upgrade to GraphiQL 0.7.0
* Allow passing in operation name

## 0.2.0 (2016-03-19)

* Enhancements
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This [Plug](https://github.com/elixir-lang/plug) allows you to easily mount a Gr
end
def deps do
[{:plug_graphql, "~> 0.3"}]
[{:plug_graphql, "~> 0.3.1"}]
end
```
Expand Down
37 changes: 37 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Release process

This document 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/plug_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`

10. Update upstream repos `hello_graphql_phoenix` and `graphql_relay` and release as appropriate

## 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.
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule GraphQL.Plug.Mixfile do
use Mix.Project

@version "0.3.0"
@version "0.3.1"

@description "A Plug integration for GraphQL Elixir"
@repo_url "https://github.com/graphql-elixir/plug_graphql"
Expand Down

0 comments on commit c9d2763

Please sign in to comment.