feat(cmd): match upcoming node version with API

[vgonkivs]

Resolves #2549

docgen cmd moved to the root celestia cmd folder, so it will be a part of the c-node binary to get the correct Semantic version.

[vgonkivs]

[jcstein]

will this PR make it possible to generate the spec json file on releases? to be stored as artifacts on the release as suggested in #2611?

[jcstein]

it looks like this just outputs the version info? but not the actual api specs? am i missing something here?

[jcstein]

now it is not possible to generate the api specs?

make openrpc-gen
--> Generating OpenRPC spec
stat /Users/joshstein/celestia-node/cmd/docgen: directory not found
make: *** [openrpc-gen] Error 1

however, the version (and no actual api specs) show when you run:

$ celestia docgen
{
    "openrpc": "1.2.6",
    "info": {
        "title": "Celestia Node API",
        "description": "The Celestia Node API is the collection of RPC methods that can be used to interact with the services provided by Celestia Data Availability Nodes.",
        "version": "v0.13.2-13-gc57e39bc"
    },
    "externalDocs": {
        "description": "Celestia Node GitHub",
        "url": "https://github.com/celestiaorg/celestia-node"
    },
    "methods": []
}%               

i am quite confused at what this PR accomplishes

[jcstein]

flagging that I do not think this PR should be merged. it
(1) makes it impossible to generate rpc docs, which is counterproductive
(2) introduces celestia docgen which outputs the description of the docs with the api version, which is sort of productive, except for all the missing api docs that should come along with this spec generation

[vgonkivs]

Let me fix the spec generation. Sorry, did not test it properly

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 20.00000% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 44.77%. Comparing base (2469e7a) to head (b886feb).
Report is 42 commits behind head on main.

Files	Patch %	Lines
cmd/celestia/docgen.go	0.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3318      +/-   ##
==========================================
- Coverage   44.83%   44.77%   -0.06%     
==========================================
  Files         265      273       +8     
  Lines       14620    15253     +633     
==========================================
+ Hits         6555     6830     +275     
- Misses       7313     7628     +315     
- Partials      752      795      +43     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Wondertan]

utACK

[jcstein]

has this been tested?

[vgonkivs]

Yeap. I have tested it and it worked for me

[jcstein]

will this PR make it possible to generate the spec json file on releases? to be stored as artifacts on the release as suggested in #2611?

thank you, and does this help accomplish generation of specs for releases in #2611 ?

[jcstein]

it works for me. but why do we need 2 commands to generate the spec? shouldn't celestia docgen handle this for us?

also, in the output I get when testing make openrpc-gen, there is still --> Generating OpenRPC spec which will need to be filtered out to handle #2611

[ramin]

will this PR make it possible to generate the spec json file on releases? to be stored as artifacts on the release as suggested in #2611?

thank you, and does this help accomplish generation of specs for releases in #2611 ?

I will do that next in a separate PR @jcstein

[jcstein]

I understand that. I'm trying to understand if it helps accomplish that goal, or of it is going to add more work, that is all

[jcstein]

LGTM, also especially if it also helps to accomplish #2611 (as opposed to being unproductive toward that issue i.e. introducing more work)

[jcstein]

my only feedback would be that the celestia docgen command is a little misleading, as it doesn't actually generate the docs. the command to do that is make openrpc-gen which AFAIU uses celestia docgen?

[vgonkivs]

my only feedback would be that the celestia docgen command is a little misleading, as it doesn't actually generate the docs. the command to do that is make openrpc-gen which AFAIU uses celestia docgen?

make openrpc-gen calls docgen under the hood, passing all available modules. so to make it work, you should call
celestia docgen da fraud share etc....

But I'd remove the parameters and generate docs for all modules.

wdyt @jcstein @distractedm1nd , @renaynay, @Wondertan

[renaynay]

Utack