-
-
Notifications
You must be signed in to change notification settings - Fork 259
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
Allow package exclusions and inclusions in javadocs #1293
Open
vinnybod
wants to merge
2
commits into
bazel-contrib:master
Choose a base branch
from
confluentinc:vinnybod/upstream-javadocs-filters
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
38 changes: 36 additions & 2 deletions
38
private/tools/java/com/github/bazelbuild/rules_jvm_external/javadoc/BUILD
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,48 @@ | ||
| load("@rules_java//java:defs.bzl", "java_binary") | ||
| load("@rules_java//java:defs.bzl", "java_binary", "java_library") | ||
|
|
||
| java_library( | ||
| name = "javadoc_lib", | ||
| srcs = ["JavadocJarMaker.java"], | ||
| visibility = [ | ||
| "//tests/com/github/bazelbuild/rules_jvm_external/javadoc:__pkg__", | ||
| ], | ||
| deps = [ | ||
| ":create_jar_lib", | ||
| "//private/tools/java/com/github/bazelbuild/rules_jvm_external", | ||
| "//private/tools/java/com/github/bazelbuild/rules_jvm_external/zip", | ||
| ], | ||
| ) | ||
|
|
||
| java_binary( | ||
| name = "javadoc", | ||
| srcs = glob(["*.java"]), | ||
| main_class = "com.github.bazelbuild.rules_jvm_external.javadoc.JavadocJarMaker", | ||
| visibility = [ | ||
| "//visibility:public", | ||
| ], | ||
| runtime_deps = [ | ||
| ":javadoc_lib", | ||
| ], | ||
| ) | ||
|
|
||
| java_library( | ||
| name = "create_jar_lib", | ||
| srcs = ["CreateJar.java"], | ||
| visibility = [ | ||
| "//tests/com/github/bazelbuild/rules_jvm_external/javadoc:__pkg__", | ||
| ], | ||
| deps = [ | ||
| "//private/tools/java/com/github/bazelbuild/rules_jvm_external", | ||
| "//private/tools/java/com/github/bazelbuild/rules_jvm_external/zip", | ||
| ], | ||
| ) | ||
|
|
||
| java_binary( | ||
| name = "create_jar", | ||
| main_class = "com.github.bazelbuild.rules_jvm_external.javadoc.CreateJar", | ||
| visibility = [ | ||
| "//visibility:public", | ||
| ], | ||
| runtime_deps = [ | ||
| ":create_jar_lib", | ||
| ], | ||
| ) |
87 changes: 87 additions & 0 deletions
87
private/tools/java/com/github/bazelbuild/rules_jvm_external/javadoc/CreateJar.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package com.github.bazelbuild.rules_jvm_external.javadoc; | ||
|
|
||
| import com.github.bazelbuild.rules_jvm_external.zip.StableZipEntry; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
| import java.io.UncheckedIOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.nio.file.StandardCopyOption; | ||
| import java.util.Comparator; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
| import java.util.zip.ZipEntry; | ||
| import java.util.zip.ZipOutputStream; | ||
|
|
||
| public class CreateJar { | ||
|
|
||
| public static void main(String[] args) throws IOException { | ||
| Path out = Paths.get(args[0]); | ||
| Set<Path> inputs = Stream.of(args).skip(1).map(Paths::get).collect(Collectors.toSet()); | ||
|
|
||
| Path tmpDir = Files.createTempDirectory("create-jar-temp"); | ||
| tmpDir.toFile().deleteOnExit(); | ||
|
|
||
| for (Path input : inputs) { | ||
| if (!Files.isDirectory(input)) { | ||
| Files.copy(input, tmpDir.resolve(input.getFileName()), StandardCopyOption.REPLACE_EXISTING); | ||
| continue; | ||
| } | ||
|
|
||
| Files.walk(input) | ||
| .forEachOrdered( | ||
| source -> { | ||
| try { | ||
| Path target = tmpDir.resolve(input.relativize(source)); | ||
| if (Files.isDirectory(source)) { | ||
| Files.createDirectories(target); | ||
| } else { | ||
| Files.createDirectories(target.getParent()); | ||
| Files.copy(source, target); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| createJar(out, tmpDir); | ||
| } | ||
|
|
||
| public static void createJar(Path out, Path inputDir) throws IOException { | ||
| try (OutputStream os = Files.newOutputStream(out); | ||
| ZipOutputStream zos = new ZipOutputStream(os); | ||
| Stream<Path> walk = Files.walk(inputDir)) { | ||
|
|
||
| walk.sorted(Comparator.naturalOrder()) | ||
| .forEachOrdered( | ||
| path -> { | ||
| if (path.equals(inputDir)) { | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| if (Files.isDirectory(path)) { | ||
| String name = inputDir.relativize(path) + "/"; | ||
| ZipEntry entry = new StableZipEntry(name); | ||
| zos.putNextEntry(entry); | ||
| zos.closeEntry(); | ||
| } else { | ||
| String name = inputDir.relativize(path).toString(); | ||
| ZipEntry entry = new StableZipEntry(name); | ||
| zos.putNextEntry(entry); | ||
| try (InputStream is = Files.newInputStream(path)) { | ||
| com.github.bazelbuild.rules_jvm_external.ByteStreams.copy(is, zos); | ||
| } | ||
| zos.closeEntry(); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
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.
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.
deploy_envgets added back into the docs so we were generating docs for kotlin stdlib which seems wrong. Changed to excluded_workspace to keep it out of the docs, which seems like what was actually intended.This is also how we handle
scala_exportin confluent's fork of rules_jvm_external.