-
-
Notifications
You must be signed in to change notification settings - Fork 661
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
Stardoc generates API docs for core rules #3000
Conversation
This is amazing, thank you! |
We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. ℹ️ Googlers: Go here for more info. |
@googlebot I fixed it. |
We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. ℹ️ Googlers: Go here for more info. |
@googlebot I fixed it. |
All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the ℹ️ Googlers: Go here for more info. |
1 similar comment
All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the ℹ️ Googlers: Go here for more info. |
@googlebot I consent. |
@steeve this is going stale and will be hard for me to keep it going for long. Can I help get it reviewed? |
If you sync this up I'm happy to merge without @steeve giving it another look |
Avoids needing to manually keep rst content in sync with starlark changes.
#3004 landed while this was open, I moved the newly introduced |
load("@bazel_skylib//rules:write_file.bzl", "write_file") | ||
load("@bazel_skylib//rules:diff_test.bzl", "diff_test") | ||
|
||
def stardoc_with_diff_test( |
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.
incidentally we have this function in aspect-build/bazel-lib now, and that repo is Apache 2, so we could possibly introduce a dependency on it from rules_go if you want to avoid maintaining this
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.
I'd like to keep deps in rules_go
to a bare minimum for end users so I think keeping it in repo is not a terrible situation. Have you considered getting it into the stardoc
repo? Then using it would be straight forward and wouldn't add any more deps.
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.
I haven't tried, based on Googlers silent on my https://github.com/bazelbuild/bazel-skylib/pulls/alexeagle and especially bazelbuild/bazel-skylib#321 I don't want to spend the time if it's never going to merge.
Thanks for getting this in!
Replaces hand-maintained core.rst file.
go_binary