docs: added magefile target to generate docs #2208
Open
+2,944
−2,357
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area/CLI
Signed-off-by: Kartikay <kartikay_2101ce32@iitp.ac.in>
kartikaysaxena
force-pushed
the
spicedb-docs
branch
from
21bf9df to
e7ec237
Compare
kartikaysaxena
commented
Jan 20, 2025
| ) | ||
|
|
||
| replace github.com/authzed/spicedb => ../ |
There was a problem hiding this comment.
Used this otherwise the magefile would have broken for now as I used go get github.com/authzed/spicedb/pkg/cmd which does not use the local package. The lint is also failing because of this reason.
There was a problem hiding this comment.
Also this is because google.golang.org/protobuf has a dependency of v1.36.1 in spicedb but in magefile it is v1.34.2 so when trying to import the package it resolves the dependency to 1.36.1 and lint:all calls gen:proto which is enforcing the latest version.
Signed-off-by: Kartikay <kartikay_2101ce32@iitp.ac.in>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Migrated the logic for initialising
rootCmdtopkg/cmdin a function which is invoked by a magefile targetgen:docsto generate documentation for SpiceDB. Also added a workflow which would detect changes and run the target to generate docs and auto submit the diff theauthzed/docs, docs currently at authzed/docs#298