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

Commit

Permalink
5.0.0 and add bump procedure to changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
comigor committed Feb 21, 2020
1 parent 6a2b633 commit 9f5e995
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 10 deletions.
22 changes: 17 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# CHANGELOG

## 5.0.0-beta.0
## 5.0.0
**MAJOR BREAKING CHANGE**
In this version we moved from `json` to `graphql` schema parsing.
In this version we moved from `json` to `graphql` (SDL) schema parsing.
This allowed us to get rid off ±1200 lines of code which makes the
project support much easier. The test files with schema definitions
became more clear and human readable.

If you already have your schema in SDL format, just point to it in `build.yaml`.
If not, use this [snippet][introspection-to-sdl-snippet]
(from [this Apollo article][apollo-3-ways-schema]) or online helpers like
[this one][introspection-to-sdl-online] to convert from one to another.

## 4.0.2
- Only add unknownEnumValue on non-list enums
- Consider all classes to include reference to meta package
Expand Down Expand Up @@ -68,7 +73,7 @@ avoiding breaking/crashing the client.
- Allow to dispose `ArtemisClient` underlining http client when possible

## 3.0.0
- BREAKING: Marks non nullable input field as `@required` [#68](https://github.com/comigor/artemis/pull/68)
- BREAKING: Marks non nullable input field as `@required` [#68][pr-68]

## 2.2.2
- Make lists as input objects work again
Expand All @@ -80,7 +85,7 @@ avoiding breaking/crashing the client.
- Add "Articles and videos" category on README

## 2.2.0
- Share fragments between queries and schemas (see `fragments_glob`) [#65](https://github.com/comigor/artemis/pull/65)
- Share fragments between queries and schemas (see `fragments_glob`) [#65][pr-65]

## 2.1.4
- Add missing prefix to generated enums
Expand Down Expand Up @@ -196,7 +201,7 @@ Set HTTP headers only when using default HTTP client.
## 0.2.0 BREAKING
Completely overhaul how this works.

Artemis won't generate a full schema typing anymore. Instead, it will use the schema to generate typings from a specific query or mutation. It will also create helper functions to execute those queries. See [README](./README.md) for more info.
Artemis won't generate a full schema typing anymore. Instead, it will use the schema to generate typings from a specific query or mutation. It will also create helper functions to execute those queries. See [README][readme] for more info.

This is totally a breaking change but as this library is still on alpha, I should keep it under 1.0.

Expand Down Expand Up @@ -225,3 +230,10 @@ This is totally a breaking change but as this library is still on alpha, I shoul
- Consider custom scalars
- Not even compile from scratch
- Lot of bugs

[readme]: ./README.md
[pr-65]: https://github.com/comigor/artemis/pull/65
[pr-68]: https://github.com/comigor/artemis/pull/68
[apollo-3-ways-schema]: https://blog.apollographql.com/three-ways-to-represent-your-graphql-schema-a41f4175100d
[introspection-to-sdl-snippet]: https://gist.github.com/stubailo/041999ba5b8b15cede60b93ff9a38f53
[introspection-to-sdl-online]: https://codesandbox.io/s/pnmoxolx4
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@
[![Pub Package](https://img.shields.io/pub/v/artemis.svg)](https://pub.dev/packages/artemis)
[![GitHub Actions](https://github.com/comigor/artemis/workflows/test/badge.svg)](https://github.com/comigor/artemis/actions)

Artemis is a code generator that looks for `schema.graphql` (GraphQL Introspection Query response data) and `*.graphql` files and builds `.dart` files typing that query, based on the schema. That's similar to what [Apollo](https://github.com/apollographql/apollo-client) does (Artemis is his sister anyway).
Artemis is a code generator that looks for `schema.graphql` (GraphQL SDL - Schema Definition Language) and `*.graphql` files and builds `.dart` files typing that query, based on the schema. That's similar to what [Apollo](https://github.com/apollographql/apollo-client) does (Artemis is his sister anyway).

---

## **Installation**
Add the following to your `pubspec.yaml` file to be able to do code generation:
```yaml
dev_dependencies:
artemis: '>=2.0.0 <3.0.0'
artemis: '>=5.0.0 <6.0.0'
build_runner: ^1.5.0
json_serializable: ^3.0.0
```
The generated code uses the following packages in run-time:
```yaml
dependencies:
artemis: '>=2.0.0 <3.0.0' # only if you're using ArtemisClient!
artemis: '>=5.0.0 <6.0.0' # only if you're using ArtemisClient!
json_serializable: ^3.0.0
equatable: ^0.6.1
meta: '>=1.0.0 <2.0.0' # only if you have non nullable fields
Expand Down
2 changes: 1 addition & 1 deletion lib/builder.dart
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Make sure that `queries_glob` your build.yaml file include GraphQL queries files
.first;
} catch (e) {
throw Exception('''Schema `${schemaMap.schema}` was not found!
Make sure the file exists and you've typed it conrrectly on build.yaml.
Make sure the file exists and you've typed it correctly on build.yaml.
''');
}

Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: artemis
version: 5.0.0-beta.0
version: 5.0.0

authors:
- Igor Borges <igor@borges.dev>
Expand Down

0 comments on commit 9f5e995

Please sign in to comment.