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

fix: added dokka and fix doc generation #1249

Merged
merged 1 commit into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
67 changes: 67 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Copyright 2023 Google LLC
#
# 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.

# A workflow that updates the gh-pages branch whenever a new release is made
name: Update documentation

on:
push:
branches: [ main ]
repository_dispatch:
types: [gh-pages]
workflow_dispatch:

jobs:
gh-page-sync:
runs-on: ubuntu-latest

steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout Repo
uses: actions/checkout@v2

- name: Gradle Wrapper Validation
uses: gradle/[email protected]

- name: Set up JDK 17
uses: actions/[email protected]
with:
java-version: '17'
distribution: 'temurin'

# Run dokka and create tar
- name: Generate documentation
run: |
./gradlew dokkaHtml

echo "Creating tar for generated docs"
cd $GITHUB_WORKSPACE/build/dokka/html && tar cvf ~/android-maps-utils-docs.tar .

echo "Unpacking tar into gh-pages branch"
git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
cd $GITHUB_WORKSPACE && git checkout gh-pages && tar xvf ~/android-maps-utils-docs.tar

# Commit changes and create a PR
- name: PR Changes
uses: peter-evans/create-pull-request@v3
with:
token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }}
commit-message: 'docs: Update docs'
author: googlemaps-bot <[email protected]>
committer: googlemaps-bot <[email protected]>
labels: docs
title: 'docs: Update docs'
body: |
Updated GitHub pages with latest from `./gradlew dokkaHtml`.
branch: googlemaps-bot/update_gh_pages
6 changes: 4 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ buildscript {
classpath 'com.mxalbert.gradle:jacoco-android:0.2.1'
classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.9.0"
}
}


allprojects {
repositories {
google()
Expand Down Expand Up @@ -104,9 +106,9 @@ subprojects { project ->
}

tasks.register('javadocJar', Jar) {
dependsOn javadoc
dependsOn dokkaHtml
archiveClassifier = 'javadoc'
from javadoc.destinationDir
from dokkaHtml.outputDirectory
}

publishing {
Expand Down
1 change: 1 addition & 0 deletions library/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
plugins {
id 'kotlin-android'
id 'org.jetbrains.dokka'
}

android {
Expand Down