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

Publish Dokka generated API documentation #46

Open
CommanderTvis opened this issue Apr 30, 2021 · 3 comments
Open

Publish Dokka generated API documentation #46

CommanderTvis opened this issue Apr 30, 2021 · 3 comments
Assignees

Comments

@CommanderTvis
Copy link

No description provided.

@dievsky
Copy link
Contributor

dievsky commented Apr 30, 2021

Publish it where? We have javadoc on Maven Central.

@CommanderTvis
Copy link
Author

For example, on GitHub pages

@dievsky dievsky self-assigned this May 4, 2021
@CommanderTvis
Copy link
Author

CommanderTvis commented Jun 15, 2021

Example configuration for Github Actions:

name: Dokka publication

on:
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-20.04
    steps:
      - name: Checkout the repo
        uses: actions/checkout@v2
      - name: Set up JDK 11
        uses: DeLaGuardo/[email protected]
        with:
          graalvm: 21.1.0
          java: java11
          arch: amd64
      - name: Cache gradle
        uses: actions/cache@v2
        with:
          path: ~/.gradle/caches
          key: ubuntu-20.04-gradle-${{ hashFiles('*.gradle.kts') }}
          restore-keys: |
            ubuntu-20.04-gradle-
      - name: Cache konan
        uses: actions/cache@v2
        with:
          path: ~/.konan
          key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
          restore-keys: |
            ${{ runner.os }}-gradle-
      - name: Build
        run: ./gradlew dokkaHtml --no-daemon --no-parallel --stacktrace
      - name: Deploy to GitHub Pages
        uses: JamesIves/[email protected]
        with:
          branch: gh-pages
          folder: build/dokka/html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants