Fix stardoc_with_diff_test linter warnings (#390)
Google internal linters are flagging skylib 1.3.0 because the stardoc_with_diff_test macro lack a copyright notice and does not use a `name` parameter.
This commit is contained in:
parent
6a17363a3c
commit
c5ededc7e8
23
docs/BUILD
23
docs/BUILD
|
@ -3,116 +3,139 @@ load("//docs/private:stardoc_with_diff_test.bzl", "stardoc_with_diff_test", "upd
|
|||
licenses(["notice"])
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "analysis_test",
|
||||
bzl_library_target = "//rules:analysis_test",
|
||||
out_label = "//docs:analysis_test_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "build_test",
|
||||
bzl_library_target = "//rules:build_test",
|
||||
out_label = "//docs:build_test_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "collections",
|
||||
bzl_library_target = "//lib:collections",
|
||||
out_label = "//docs:collections_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "common_settings",
|
||||
bzl_library_target = "//rules:common_settings",
|
||||
out_label = "//docs:common_settings_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "copy_directory",
|
||||
bzl_library_target = "//rules:copy_directory",
|
||||
out_label = "//docs:copy_directory_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "copy_file",
|
||||
bzl_library_target = "//rules:copy_file",
|
||||
out_label = "//docs:copy_file_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "dicts",
|
||||
bzl_library_target = "//lib:dicts",
|
||||
out_label = "//docs:dicts_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "diff_test",
|
||||
bzl_library_target = "//rules:diff_test",
|
||||
out_label = "//docs:diff_test_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "expand_template",
|
||||
bzl_library_target = "//rules:expand_template",
|
||||
out_label = "//docs:expand_template_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "native_binary",
|
||||
bzl_library_target = "//rules:native_binary",
|
||||
out_label = "//docs:native_binary_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "new_sets",
|
||||
bzl_library_target = "//lib:new_sets",
|
||||
out_label = "//docs:new_sets_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "partial",
|
||||
bzl_library_target = "//lib:partial",
|
||||
out_label = "//docs:partial_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "paths",
|
||||
bzl_library_target = "//lib:paths",
|
||||
out_label = "//docs:paths_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "run_binary",
|
||||
bzl_library_target = "//rules:run_binary",
|
||||
out_label = "//docs:run_binary_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "selects",
|
||||
bzl_library_target = "//lib:selects",
|
||||
out_label = "//docs:selects_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "select_file",
|
||||
bzl_library_target = "//rules:select_file",
|
||||
out_label = "//docs:select_file_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "shell",
|
||||
bzl_library_target = "//lib:shell",
|
||||
out_label = "//docs:shell_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "structs",
|
||||
bzl_library_target = "//lib:structs",
|
||||
out_label = "//docs:structs_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "subpackages",
|
||||
bzl_library_target = "//lib:subpackages",
|
||||
out_label = "//docs:subpackages_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "types",
|
||||
bzl_library_target = "//lib:types",
|
||||
out_label = "//docs:types_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "unittest",
|
||||
bzl_library_target = "//lib:unittest",
|
||||
out_label = "//docs:unittest_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "versions",
|
||||
bzl_library_target = "//lib:versions",
|
||||
out_label = "//docs:versions_doc.md",
|
||||
)
|
||||
|
||||
stardoc_with_diff_test(
|
||||
name = "write_file",
|
||||
bzl_library_target = "//rules:write_file",
|
||||
out_label = "//docs:write_file_doc.md",
|
||||
)
|
||||
|
|
|
@ -1,3 +1,17 @@
|
|||
# Copyright 2022 The Bazel Authors. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""Helpers for keeping stardoc documentation up-to-date.
|
||||
|
||||
These are currently a private API in bazel-skylib.
|
||||
|
@ -14,6 +28,7 @@ load("@bazel_skylib//rules:write_file.bzl", "write_file")
|
|||
load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
|
||||
|
||||
def stardoc_with_diff_test(
|
||||
name,
|
||||
bzl_library_target,
|
||||
out_label):
|
||||
"""Creates a stardoc target coupled with a `diff_test` for a given `bzl_library`.
|
||||
|
@ -21,15 +36,15 @@ def stardoc_with_diff_test(
|
|||
This is helpful for minimizing boilerplate in repos wih lots of stardoc targets.
|
||||
|
||||
Args:
|
||||
name: the stardoc target name
|
||||
bzl_library_target: the label of the `bzl_library` target to generate documentation for
|
||||
out_label: the label of the output MD file
|
||||
"""
|
||||
|
||||
out_file = out_label.replace("//", "").replace(":", "/")
|
||||
|
||||
# Generate MD from .bzl
|
||||
stardoc(
|
||||
name = out_file.replace("/", "_").replace(".md", "-docgen"),
|
||||
name = name,
|
||||
out = out_file.replace(".md", "-docgen.md"),
|
||||
input = bzl_library_target + ".bzl",
|
||||
deps = [bzl_library_target],
|
||||
|
|
Loading…
Reference in New Issue