This repository has been archived by the owner on Jul 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
Showing
4 changed files
with
54 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters