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

Commit c9d2763

Browse files
author
Josh Price
committed
Release v0.3.1
Also add `RELEASE.md` to mirror the release process in GraphQL core
1 parent d8fb53d commit c9d2763

File tree

4 files changed

+54
-2
lines changed

4 files changed

+54
-2
lines changed

CHANGELOG.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Changelog
22

3+
## 0.3.1 (2016-05-30)
4+
5+
* Enhancements
6+
* Upgrade to GraphiQL 0.7.1
7+
8+
* Bugfixes
9+
* Fix GraphiQL bug where GraphQL server was assumed to be mounted at `/graphql`
10+
11+
## 0.3.0 (2016-05-30)
12+
13+
* Enhancements
14+
* Upgrade to GraphQL 0.3.0
15+
* Upgrade to GraphiQL 0.7.0
16+
* Allow passing in operation name
17+
318
## 0.2.0 (2016-03-19)
419

520
* Enhancements

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This [Plug](https://github.com/elixir-lang/plug) allows you to easily mount a Gr
3333
end
3434
3535
def deps do
36-
[{:plug_graphql, "~> 0.3"}]
36+
[{:plug_graphql, "~> 0.3.1"}]
3737
end
3838
```
3939

RELEASE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Release process
2+
3+
This document outlines the release process:
4+
5+
1. Ensure you are running on the oldest supported Elixir version (check `.travis.yml`)
6+
7+
2. Ensure `CHANGELOG.md` is updated and add current date
8+
9+
3. Change the version number in `mix.exs` and `README.md`
10+
11+
4. Run `mix test` to ensure all tests pass
12+
13+
5. Commit changes above with title "Release vVERSION" and push to GitHub
14+
15+
git add .
16+
git commit -m"Release vX.Y.Z"
17+
git push origin master
18+
19+
6. Check CI is green
20+
21+
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
22+
23+
8. Publish new hex release with `mix hex.publish`
24+
25+
9. Publish hex docs with `mix hex.docs`
26+
27+
10. Update upstream repos `hello_graphql_phoenix` and `graphql_relay` and release as appropriate
28+
29+
## Deprecation policy
30+
31+
GraphQL deprecations happen in 3 steps:
32+
33+
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.
34+
35+
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.
36+
37+
3. The feature is removed. This can only happen on major releases.

mix.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule GraphQL.Plug.Mixfile do
22
use Mix.Project
33

4-
@version "0.3.0"
4+
@version "0.3.1"
55

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

0 commit comments

Comments
 (0)