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 #1450

Merged
merged 8 commits into from
Apr 27, 2022

Conversation

tripolkaandrey
Copy link
Contributor

@tripolkaandrey tripolkaandrey commented Apr 26, 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 dead code from buildSrc, like the groovy directory, was removed.

Important details

  • Breaking changes were introduced in the 2.11.0 version of error_prone_core leading to a compilation error. The 2.10.0 version was forced for all other Error Prone parts to resolve the issue.

  • Dokka has an issue when dealing with Metaspace. The problem and its workaround were mentioned in this PR in config. This repository is large enough to run into OutOfSpaceError, so MaxMetaspaceSize was manually set as a parameter to the Gradle build CLI command in build-on-ubuntu and build-on-windows GitHub workflows to overcome the issue.

@tripolkaandrey tripolkaandrey self-assigned this Apr 26, 2022
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 26, 2022

Codecov Report

Merging #1450 (bee545e) into master (b619573) will increase coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #1450      +/-   ##
============================================
+ Coverage     91.44%   91.45%   +0.01%     
+ Complexity     4979     4978       -1     
============================================
  Files           626      626              
  Lines         15347    15347              
  Branches        894      894              
============================================
+ Hits          14034    14036       +2     
+ Misses         1006     1004       -2     
  Partials        307      307              

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 26, 2022 09:40
@tripolkaandrey tripolkaandrey marked this pull request as draft April 26, 2022 09:59
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 26, 2022 10:43
@tripolkaandrey tripolkaandrey marked this pull request as draft April 26, 2022 12:51
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 26, 2022 13:32
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.

LGTM.

@tripolkaandrey tripolkaandrey merged commit a8a75b5 into master Apr 27, 2022
@tripolkaandrey tripolkaandrey deleted the add-dokka-documentation-to-artifacts branch April 27, 2022 07:59
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.

None yet

2 participants