Skip to content

Commit

Permalink
[build] fixed multi version documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fab1an committed Jul 13, 2023
1 parent eb67203 commit c7849ba
Show file tree
Hide file tree
Showing 94 changed files with 7,874 additions and 4 deletions.
36 changes: 33 additions & 3 deletions .github/workflows/build-master.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: Build
name: Build Master

on:
push:
branches:
- master

permissions:
contents: read
contents: write
pages: write
id-token: write

Expand All @@ -24,19 +24,49 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- uses: actions/setup-java@v3
with:
distribution: 'temurin'
java-version: '17'
cache: "gradle"

- name: Build
run: ./gradlew build

- name: Build documentation
run: ./gradlew dokkaHtml

- uses: actions/configure-pages@v3

- uses: actions/upload-pages-artifact@v1
with:
path: 'build/dokka/html'
- name: Deploy to GitHub Pages

- name: Deploy to Documentation GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

- name: Delete directory ./build/dokka/html/older
run: rm -Rf ./build/dokka/html/older

- name: Set VERSION from json
run: |
echo "VERSION=$(cat ./build/dokka/html/version.json | jq -r '.version')" >> "$GITHUB_ENV"
- name: Archive documentation
run: |
rm -Rf "./documentation/${{env.VERSION}}"
mv ./build/dokka/html "./documentation/${{env.VERSION}}"
- name: Commit documentation
run: |
# setup the username and email
git config user.name "GitHub Actions"
git config user.email "<>"
# Stage the file, commit and push
git add documentation
git commit -m "[ci-commit] [documentation] updated documentation for ${{env.VERSION}}" || true
git push origin master
14 changes: 13 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ plugins {
id 'org.jetbrains.kotlin.multiplatform' version "1.9.0"
id("convention.publication")
id "org.jetbrains.dokka" version "1.8.20"
id "maven-publish"
}

group 'com.fab1an'
Expand Down Expand Up @@ -46,6 +45,10 @@ kotlin {
}
}

dependencies {
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.20")
}

tasks.withType(DokkaTask.class) {
dokkaSourceSets {
configureEach {
Expand All @@ -54,5 +57,14 @@ tasks.withType(DokkaTask.class) {
packageListUrl.set(new URL("https://square.github.io/okio/3.x/okio/okio/package-list"))
}
}

}
String versioningPluginConfiguration = """
{
"olderVersionsDir": "${projectDir.toPath().resolve("documentation")}"
}
"""
pluginsMapConfiguration.set(
["org.jetbrains.dokka.versioning.VersioningPlugin": versioningPluginConfiguration]
)
}
Empty file added documentation/.gitkeep
Empty file.
4 changes: 4 additions & 0 deletions documentation/1.0.0/images/anchor-copy-button.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions documentation/1.0.0/images/arrow_down.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions documentation/1.0.0/images/copy-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions documentation/1.0.0/images/copy-successful-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions documentation/1.0.0/images/footer-go-to-link.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions documentation/1.0.0/images/go-to-top-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions documentation/1.0.0/images/logo-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions documentation/1.0.0/images/nav-icons/abstract-class-kotlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions documentation/1.0.0/images/nav-icons/abstract-class.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions documentation/1.0.0/images/nav-icons/annotation-kotlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions documentation/1.0.0/images/nav-icons/annotation.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions documentation/1.0.0/images/nav-icons/class-kotlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions documentation/1.0.0/images/nav-icons/class.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions documentation/1.0.0/images/nav-icons/enum-kotlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions documentation/1.0.0/images/nav-icons/enum.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions documentation/1.0.0/images/nav-icons/exception-class.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions documentation/1.0.0/images/nav-icons/field-value.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions documentation/1.0.0/images/nav-icons/field-variable.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions documentation/1.0.0/images/nav-icons/function.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions documentation/1.0.0/images/nav-icons/interface-kotlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions documentation/1.0.0/images/nav-icons/interface.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions documentation/1.0.0/images/nav-icons/object.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions documentation/1.0.0/images/theme-toggle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c7849ba

Please sign in to comment.