Skip to content

Add a task that creates a tar.gz of the javadoc #155

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.

Sign up for GitHub

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

Open
kcooney wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a task that creates a tar.gz of the javadoc #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,7 @@ Before publishing to Maven Central, consider publishing to Maven Local.
9. Decrypt `lib2813-maven-publishing.tar.gz.gpg`
10. Copy the last five lines of the decrypted file to your personal `gradle.properties` file
11. Run `./gradlew publishToMavenCentral`
12. Celebrate!
12. Generate Javadoc by running `./gradlew archiveJavadoc`
13. Copy `build/docs/javadoc/javadoc.tar.gz` to the web site and extract it
14. Update the 'latest' symlink to point to the latest javadoc
15. Celebrate!
30 changes: 29 additions & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,32 @@ allprojects {
}
}
}
}
}

tasks.register('archiveJavadoc', Tar) {
archiveFileName = 'javadoc.tar.gz'
compression = Compression.GZIP
destinationDirectory = layout.buildDirectory.dir("docs/javadoc")

from(tasks.named('generateJavadocIndex'))

subprojects.forEach { sub ->
sub.tasks.withType(Javadoc).configureEach { javadocTask ->
from(javadocTask.destinationDir) {
into sub.name
}
}
}
}

tasks.register('generateJavadocIndex', Copy) {
from 'site/javadoc/latest'
include 'index.j2.html'
into layout.buildDirectory.dir("docs/javadoc")

// Rename the file during the copy process
rename { 'index.html' }

// This performs the variable substitution
expand([version: gradle.lib_version])
}
2 changes: 1 addition & 1 deletion buildSrc/src/main/groovy/publishing-conventions.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ plugins {
}

group = 'com.team2813.lib2813'
version = "2.0.0"
version = gradle.lib_version

mavenPublishing {

Expand Down
1 change: 1 addition & 0 deletions settings.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@
*/

rootProject.name = 'lib2813'
gradle.ext.lib_version = "2.0.0"
include 'core', 'limelight', 'vision', 'testing'
include 'vendor:ctre', 'vendor:rev'
28 changes: 28 additions & 0 deletions site/javadoc/latest/index.j2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>lib2813 2.0.0 Javadoc</title>
<link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css">
<link rel="stylesheet" href="../stylesheet.css">
</head>
<body>
<header>
<h1>lib2813 {{ version }} Javadoc</h1>
</header>
<main>
<ul>
<li><a href="core/">core</a></li>
<li><a href="limelight/">limelight</a></li>
<li><a href="testing/">testing</a></li>
<li><a href="vendor-ctre/">vendor-ctre</a></li>
<li><a href="vendor-rev/">vendor-rev</a></li>
<li><a href="vision"/>vision</a></li>
</ul>
</main>
<footer>
<p>Copyright 2023-2026 Prospect Robotics SWENext Club</p>
</footer>
</body>
</html>
6 changes: 6 additions & 0 deletions site/javadoc/stylesheet.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
body > header {
--accent-bg: #4D7A97;
}
:root {
--accent: #4D7A97;
}
Loading