v1.5.1

Changelog

• 2d899c2 Bump to version v1.5.1
• 13340ab Escape special characters in Markdown anchors
• c1b5714 Merge pull request #460 from derlin/feature/457-markdown-anchors
• 2dde019 Merge pull request #461 from pseudomuto/bump_go_protoc
• 9d9cb9f Merge pull request #462 from pseudomuto/move_ci_to_github
• c3f4578 Merge pull request #463 from pseudomuto/push_to_docker_on_tag
• bc8d652 Merge pull request #474 from pseudomuto/go_releaser
• 16c28d2 Publish to DockerHub when a new tag is created
• 84fae50 Setting up goreleaser to handle releases
• 6178c66 Switch from Travis to GitHub actions
• a22af56 Trigger CI run
• 979ca3c Trigger CI run
• 30058b9 Trigger CI run
• 9e24fa2 Update CI badge in README
• ab35ee6 Update dockerignore
• 89d7d93 Update go, protoc, and drop resources script
• 8bf2420 Update gopkg.in/yaml.v2
• 4361808 gofmt -s -w .

protoc-gen-doc v1.5.0

Added

• Add source_relative flag to generate files next to their source #450

protoc-gen-doc v1.4.1

NOTE: This is the same as 1.4.0, there was a lint error that snuck in and prevented the deploy to Docker Hub, so I fixed that and cut a new patch.

Added

• Add support for OneOf in templates #436
• Note deprecated fields in HTML, Markdown, and Docbook outputs #426

Fixed

• Upgrade envoyproxy/protoc-gen-validate to v0.3.0-java #418
• Tidy up modules

protoc-gen-doc v1.4.0

Added

• Add support for OneOf in templates #436
• Note deprecated fields in HTML, Markdown, and Docbook outputs #426

Fixed

• Upgrade envoyproxy/protoc-gen-validate to v0.3.0-java #418
• Tidy up modules

protoc-gen-doc v1.3.2

Changed

• Stripped unnecessary whitespace from markdown templates #410
• Renamed lyft_validate extension to envoyproxy_validate
  #392
• Fixed envoyproxy_validate rules with slice values such as in and not_in
  #392

protoc-gen-doc v1.3.1

Changed

• Switched from dep to go modules

protoc-gen-doc v1.3.0

Added

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

protoc-gen-doc v1.2.0

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).

protoc-gen-doc v1.1.0

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)

protoc-gen-doc v1.0.0

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