Skip to content
This repository was archived by the owner on Feb 14, 2023. It is now read-only.

Commit 83e8586

Browse files
committed
Add CHANGELOG.md and UPGRADE.md
1 parent f60e9ec commit 83e8586

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased](https://github.com/mll-lab/laravel-graphql-playground/compare/v2.0.0...master)
9+
10+
## [v2.0.0](https://github.com/mll-lab/laravel-graphql-playground/compare/v1.1.0...v2.0.0)
11+
12+
### Added
13+
14+
- Support Lumen
15+
- Load routes through a file: `src/routes.php`
16+
17+
### Changed
18+
19+
- Make the `GraphQLPlaygroundController` use `__invoke()` instead of `get()`
20+
- Move the `route_name` configuration option into `route.uri`
21+
22+
### Removed
23+
24+
- Disable the `route.domain` configuration option by default
25+
26+
## Pre-v2
27+
28+
We just started maintaining a changelog starting from v2.
29+
30+
If someone wants to make one for previous versions, PR's are welcome.

UPGRADE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Upgrade guide
2+
3+
This document provides guidance for upgrading between major versions.
4+
5+
## v1 to v2
6+
7+
Compare your `graphql-playground.php` against the latest [default configuration](src/graphql-playground.php).
8+
The configuration options for the `route` changed.
9+
10+
If you were calling the `GraphQLPlaygroundController` directly, change the reference
11+
to use `__invoke()`:
12+
13+
```diff
14+
-'uses' => \MLL\GraphQLPlayground\GraphQLPlaygroundController::class . '@get',
15+
+'uses' => \MLL\GraphQLPlayground\GraphQLPlaygroundController::class,
16+
```

0 commit comments

Comments
 (0)