Skip to content

@pseudomuto pseudomuto released this Apr 15, 2019 · 15 commits to master since this release

Added

  • Support for options and extended options in files, services, methods, enums, enum values, messages and fields #376
Assets 5

@pseudomuto pseudomuto released this Mar 13, 2019 · 30 commits to master since this release

Added

  • Added Sprig functions to renderer contexts
  • Added IsMap to MessageField objects indicating whether or not the field is a map field
  • Added RequestStreaming and ResponseStreaming to ServiceMethod objects indicating whether the request and/or response are streaming. Updated the templates to add "stream" indicators to method requests and responses.
  • Support for recursively adding nested enums and messages.

Changed

  • Bumped protobuf to 3.6.1 in docker container

Fixed

  • CI issue related to Regexp comparison on Golang master
  • Markdown template was incorrectly links response types to request types
  • Markdown template anchor tags were self-closing (invalid).
Assets 5

@pseudomuto pseudomuto released this Mar 13, 2018 · 57 commits to master since this release

Added

  • Switch to using protokit to handle parsing and running the plugin
  • Default values are not included in the built-in templates
  • Added the ability to ignore certain files by adding :pattern[,pattern] to --doc_opt
  • Added -help and -version flags to the binary (e.g. ./protoc-gen-doc -help)

Changed

  • Dev tooling, now using dep and retool
  • CI setup to use go 1.10 (and master) and protoc 3.5.1
  • Docker image updated to use protoc 3.5.1 as well

Fixed

  • Several issues with the documentation
  • NrBr filter was a little too aggressive

Removed

  • The entire parser package (in favor of protokit)
Assets 5

@pseudomuto pseudomuto released this Sep 27, 2017 · 89 commits to master since this release

New things

  • Support for both proto2 and proto3!
  • Application is now dockerized, no need to install it (unless you want to of course)
  • Ported to Go and precompiled for Linux, OSX, and Windows
  • Added test coverage to ensure functionality and prevent regressions
  • Ignore comments starting with @exclude
  • Added (and backfilled) CHANGELOG.md
  • Added CONTRIBUTING.md

Bug fixes

  • Message enums no longer included in file enums (#288)
  • Added top-level files key for JSON output and camelCased all fields (#289)
  • Fixed issue with TOC in Markdown not nesting correctly (#293)
  • No need to worry about expiring apt keys (#295)
  • Extra slashes in comment prefix no longer show up in output (#298)
  • Added field details for templates (#300)
  • Markdown headers include new line so they render correctly (#303)

Breaking changes

  • File-level comments are now attached to the syntax directive
  • JSON fields are now camelCased
  • Mustache templates replaced with golang templates
  • Dropped direct support for PDF generation (still possible with FOP)
  • doc_out flag removed in favor of doc_opt
Assets 5

@pseudomuto pseudomuto released this Aug 9, 2017 · 93 commits to master since this release

A release candidate for 1.0.0.

There are lots of changes here, which I'll enumerate in the final release. For now, check out #305 for details.

Assets 5

@pseudomuto pseudomuto released this Aug 1, 2017 · 143 commits to master since this release

A beta release of 1.0.0.

In preparation for 1.0.0, I've released this beta so that people can give it a whirl.

There are lots of changes here, which I'll enumerate in the final release. For now, check out #305 for details.

Assets 5

@pseudomuto pseudomuto released this Jul 28, 2017 · 143 commits to master since this release

An alpha release of 1.0.0.

In preparation for 1.0.0, I've released this beta so that people can give it a whirl.

There are losts of changes here, which I'll enumerate in the final release. For now, check out #305 for details.

Assets 5

@estan estan released this Feb 26, 2017

This is the ninth official release.

Changes

  • Improve installation instructions for macOS (thanks @guozheng)
  • Improve installation instructions for Debian/Ubuntu (thanks @mhaberler)
  • Add asciidoc.mustache example template (thanks @ArcEye)
  • Don't do HTML escaping in Markdown template (thanks @sunfmin)
  • Add support for JSON output
Assets 3

@estan estan released this Feb 26, 2016

This is the eight official release.

Changes

  • Add support for documenting files (#9)
  • Add support for default values (#11)
  • Add no-exclude flag to ignore @exclude directives (#13)
  • Add support for RPC services (#14) (thanks to @murph0 !)
Assets 3

@estan estan released this Jan 7, 2016 · 253 commits to master since this release

This is the seventh official release.

Changes

Assets 3
You can’t perform that action at this time.