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

update to new dokka plugin #641

Closed
6 tasks
robstoll opened this issue Oct 19, 2020 · 2 comments · Fixed by #1386
Closed
6 tasks

update to new dokka plugin #641

robstoll opened this issue Oct 19, 2020 · 2 comments · Fixed by #1386
Assignees
Milestone

Comments

@robstoll
Copy link
Owner

robstoll commented Oct 19, 2020

Non-Code related feature

Atrium is currently using dokka 0.9.8 via the tutteli-dokka plugin.
We would like to update to dokka 1.4.10

Following the things we need to do (see #683 most likely you can build on this):

  • remove classpath "ch.tutteli:tutteli-gradle-dokka:$tutteli_plugins_version" from build.gradle
  • configure the new dokka plugin instead. You don't have to bother what was configured before, you can start from scratch but we have the following requirements:
    • we need only the html report (disable the rest)
    • make sure it is not included in the normal build (./gradlew build should not trigger it) - might be this is already the case. Use ./gradlew atrium-core-api-jvm:build --dry-run and check if dokka is included. If it is, then find ways to deactivate it. We want to be able to run dokka separately
    • check if the samples for toBe are correctly rendered
  • we still want an overall report when running ghPages. You probably need to adapt gradle/scripts/gh-pages.gradle => see https://github.com/Kotlin/dokka/blob/master/runners/gradle-plugin/MIGRATION.md and https://github.com/Kotlin/dokka#multi-module-projects
    => make sure we still suppress the packages defined at the end of the gh-pages.gradle script.

Hint, the following might help to setup the plugin, note thought that Atrium is using groovy and not kotlin for gradle
https://github.com/Kotlin/dokka#using-dokka

Your first contribution?

  • Write a comment I'll work on this if you would like to take this issue over.
    This way we get the chance to revise the description in case things have changed in the meantime, we might give you additional hints and we can assign the task to you, so that others do not start as well.
  • See Your first code contribution for guidelines.
  • Do not hesitate to ask questions here or to contact us via Atrium's slack channel if you need help
    (Invite yourself in case you do not have an account yet).
@jgrgt
Copy link
Contributor

jgrgt commented Oct 27, 2020

I'll work on this

@robstoll
Copy link
Owner Author

fixed with #1386

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