Skip to content

Releases: brettchalupa/graphql-docs

v5.0.0

03 Jul 19:21
d3c9af2
Compare
Choose a tag to compare

What's Changed

  • breaking: The graphql gem 2.2.0+ breaks some of the parsing and displaying of comments from a GraphQL schema file
  • breaking: Ruby 2.6, 2.7, 3.0 are no longer supported as they are End of Life (EOL)
  • feat: CLI version flag: graphql-docs --version / graphql-docs -v
  • fix: CLI now works outside of a Bundler project
  • fix: test suite
  • chore: switch to sess-embedded gem for more maintained dependency

New Contributors

Full Changelog: v4.0.0...v5.0.0

v4.0.0

26 Jan 19:55
Compare
Choose a tag to compare

This highlight of this major release of the graphql-docs is the new CLI that comes with the gem. Install the gem and quickly generate docs from your schema with:

graphql-docs schema.graphql

The CLI supports a limited subset of configuration options, so it's best used for quick generation. For full options, use the Rake task or library builder.

  • Breaking change: drop support for Ruby 2.5 and earlier
  • CLI with limited options, e.g. graphql-docs schema.graphql
  • Dart Sass replaces Ruby Sass because Ruby Sass is deprecated — this is kinda breaking if you relied on Ruby Sass coming from the gem, but it's pretty compatible from my testing
  • Fixes:
    • Upgrade commonmarker to latest ver to address security vulnerabilities
    • commonmarker pinned to version without security vulnerability
  • Chores
    • Dev env refresh

View the v4.0.0 release on RubyGems.org.

v3.0.1

14 Oct 12:29
Compare
Choose a tag to compare
  • fix: Relieves EscapeUtils.escape_html is deprecated. Use GCI.escapeHTML instead, it's faster deprecation warning until it gets released in an downstream dependency
  • meta: Maintainership change from gjtorikian to brettchalupa

See #93 for more details of the changes in this release.

View the v3.0.1 release on RubyGems.org.

v2.0.0

24 Feb 17:58
Compare
Choose a tag to compare
  • Support for new class-based schemas: #82

v1.9.0

14 Jun 19:51
Compare
Choose a tag to compare
  • Support documenting directives (#72)

v1.8.0

04 Mar 17:55
Compare
Choose a tag to compare
  • Add deprecation warnings to connections: #68

v1.7.0

04 Jan 22:11
Compare
Choose a tag to compare
  • Support quote style comments: #65
  • Support ERB templates for landing pages: #66

v1.6.0

05 Jul 16:29
Compare
Choose a tag to compare
  • Include commonmarker: #59

v1.5.0

29 Jun 13:11
Compare
Choose a tag to compare
  • Allow filename to pass through filter: #56

v1.4.0

11 May 21:53
Compare
Choose a tag to compare
  • Accept GraphQL::Schema class directly: #49