Skip to content

Commit

Permalink
Merge pull request #316 from moufmouf/changelog41
Browse files Browse the repository at this point in the history
Adding changelog and migrating doc to 4.1
  • Loading branch information
moufmouf committed Dec 7, 2020
2 parents de04aba + eaac504 commit 030870c
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,24 @@ Breaking change:
There is one breaking change introduced in the minor version (this was important to allow PHP 8 compatibility).

- The **ecodev/graphql-upload** package (used to get support for file uploads in GraphQL input types) is now a "recommended" dependency only.
If you are using GraphQL file uploads, you need to add this package to your `composer.json`.
If you are using GraphQL file uploads, you need to add `ecodev/graphql-upload` to your `composer.json`.

New features:

- All annotations can now be accessed as PHP 8 attributes
- The `@deprecated` annotation in your PHP code translates into deprecated fields in your GraphQL schema
- You can now specify the GraphQL name of the Enum types you define
- Added the possibility to inject pure Webonyx objects in GraphQLite schema

Minor changes:

- Migrated from `zend/diactoros` to `laminas/diactoros`
- Making the annotation cache directory configurable

Miscellaneous:

- Migrated from Travis to Github actions


## 4.0

Expand Down
13 changes: 13 additions & 0 deletions docs/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ title: Migrating
sidebar_label: Migrating
---

## Migrating from v4.0 to v4.1

GraphQLite follows Semantic Versioning. GraphQLite 4.1 is backward compatible with GraphQLite 4.0. See
[semantic versioning](semver.md) for more details.

There is one exception though: the **ecodev/graphql-upload** package (used to get support for file uploads in GraphQL
input types) is now a "recommended" dependency only.
If you are using GraphQL file uploads, you need to add `ecodev/graphql-upload` to your `composer.json` by running this command:

```console
$ composer require ecodev/graphql-upload
```

## Migrating from v3.0 to v4.0

If you are a "regular" GraphQLite user, migration to v4 should be straightforward:
Expand Down
3 changes: 3 additions & 0 deletions docs/other_frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ $factory->prodMode();
// Enables dev-mode (this is the default mode: cache settings optimized for best developer experience).
// This is a shortcut for `$schemaFactory->setGlobTtl(2)`
$factory->devMode();
// If APCu is not available, Doctrine annotations are stored in files.
// This setter can configure the cache directory for Doctrine annotations.
$factory->setAnnotationCacheDir($directory);
```

### GraphQLite context
Expand Down

0 comments on commit 030870c

Please sign in to comment.