-
Notifications
You must be signed in to change notification settings - Fork 919
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(cmd): match upcoming node version with API #3318
Conversation
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? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
flagging that I do not think this PR should be merged. it |
Let me fix the spec generation. Sorry, did not test it properly |
Codecov ReportAttention: Patch coverage is
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
utACK
has this been tested? |
Yeap. I have tested it and it worked for me |
it works for me. but why do we need 2 commands to generate the spec? shouldn't also, in the output I get when testing |
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, also especially if it also helps to accomplish #2611 (as opposed to being unproductive toward that issue i.e. introducing more work)
my only feedback would be that the |
But I'd remove the parameters and generate docs for all modules. wdyt @jcstein @distractedm1nd , @renaynay, @Wondertan |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Utack
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.