Skip to content
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

Add Dokka documentation to artifacts #140

Closed
wants to merge 8 commits into from

Conversation

tripolkaandrey
Copy link
Contributor

@tripolkaandrey tripolkaandrey commented Apr 15, 2022

This PR adds Dokka-generated documentation as a publish artifact.

It is done by using functionality introduced in this PR in config.

Also, while updating the config, the outdated groovy directory was removed.

Important details

In the 2.11.0 version of error_prone_core, they broke their contract, which led to a compilation error. The 2.10.0 version was forced for all other Error Prone parts to resolve the issue.

pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Apr 15, 2022

Codecov Report

Merging #140 (6145ffd) into master (70a52eb) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #140   +/-   ##
=========================================
  Coverage     94.73%   94.73%           
  Complexity      342      342           
=========================================
  Files            52       52           
  Lines           892      892           
  Branches         18       18           
=========================================
  Hits            845      845           
  Misses           43       43           
  Partials          4        4           

@tripolkaandrey tripolkaandrey self-assigned this Apr 15, 2022
@tripolkaandrey
Copy link
Contributor Author

tripolkaandrey commented Apr 15, 2022

Vulnerabilities regarding Dokka dependencies can be fixed only by adding dependency constraints in the config repository because they originated from transitive dependencies of the precompiled script dokka-for-java.

The vulnerability of error_prone_core is not relevant as this dependency is forced to 2.10.0 which uses 30.1-jre with no mentioned vulnerabilities.

pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
@tripolkaandrey tripolkaandrey marked this pull request as ready for review April 15, 2022 11:12
Copy link
Contributor

@armiol armiol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tripolkaandrey please see my comment. LGTM otherwise.

.idea/misc.xml Outdated
<item index="1" class="java.lang.String" itemvalue="org.checkerframework.checker.nullness.qual.Nullable" />
<item index="2" class="java.lang.String" itemvalue="org.checkerframework.checker.nullness.compatqual.NullableDecl" />
<item index="3" class="java.lang.String" itemvalue="org.checkerframework.checker.nullness.compatqual.NullableType" />
<list size="14">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure this file looks more like the original one.

I don't think we really need all these @Nullable-related annotations.

pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
pom.xml Show resolved Hide resolved
@tripolkaandrey tripolkaandrey marked this pull request as draft April 19, 2022 12:16
@tripolkaandrey
Copy link
Contributor Author

It was closed in favour of a new PR.

@tripolkaandrey tripolkaandrey deleted the add-dokka-documentation-to-artifacts branch April 22, 2022 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants