protoc-gen-doc icon indicating copy to clipboard operation
protoc-gen-doc copied to clipboard

Issue #541: Add 'edition' support

Open fedor-romanovskii opened this issue 6 months ago • 7 comments

The problem was highlighted in #541

What is Changing? The plugin's response has been changed so that its supports working with the edition.

How is it Changing? The changes are quite simple. Two fields were added to the plugin's response: MinimumEdition and MaximumEdition. Also the SupportedFeatures flag has been changed to CodeGeneratorResponse_FEATURE_SUPPORTS_EDITIONS. An example of simple proto file that use editions added.

What Could Go Wrong? Perhaps the innovations in the syntax of the message fields will somehow be poorly handled, but in the added simplest example Milk.proto everything works as it should. In addition to this simple example, I can say that on my work project, a large proto file generated the documentation correctly.

fedor-romanovskii avatar Aug 20 '25 18:08 fedor-romanovskii

@pseudomuto Hello. Can you please review this PR?

fedor-romanovskii avatar Aug 20 '25 18:08 fedor-romanovskii

@Ekrekr any chance you can give this a review and merge? It seems like a relatively small change to me that would unblock many teams that want to try editions.

marksalpeter avatar Sep 19 '25 10:09 marksalpeter

I don't have approval rights - @pseudomuto is the right person to tag

Ekrekr avatar Sep 19 '25 12:09 Ekrekr

@pseudomuto hi, please consider the fix.

Nphox avatar Oct 30 '25 18:10 Nphox

@pseudomuto hi, please take a look at this PR

orikik avatar Nov 18 '25 12:11 orikik

@pseudomuto Hi! It would be great if you could find the time to take a look at this PR.

pogpp avatar Nov 18 '25 12:11 pogpp

@pseudomuto Hi, this PR would solve our problem.

kveselkov avatar Nov 19 '25 08:11 kveselkov

@fedor-romanovskii @kveselkov While waiting, I've created a fork you can use with this PR and additional features (like customizable exclude directive for ignoring comments like //buf:lint:ignore) https://github.com/daotl/protoc-gen-doc

NexZhu avatar Jan 18 '26 09:01 NexZhu