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

Move dokka plugin to its own profile to be able to skip it #633

Merged
merged 1 commit into from
Jul 21, 2021

Conversation

jmartisk
Copy link
Member

Hi. This minor change would be a great improvement for productization purposes. The problem with dokka plugin is that it does not work in the productization environment (Project Newcastle), so we need a way to turn it off.
Until now, productization engineers have been removing the plugin manually before each release. As part of streamlining and automating the build, it would be nice to have a way to simply turn it off from the command line.

Maybe there's a command line option to skip it, but I couldn't find it in the docs https://kotlin.github.io/dokka/1.4.32/user_guide/maven/usage/, so I suppose the best way to go forward would be to move the plugin into a profile that's active by default, so adding -P!dokka to the cmdline will skip it. WDYT?

Copy link
Contributor

@cescoffier cescoffier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any problem with this. @jponge WDYT?

@codecov
Copy link

codecov bot commented Jul 21, 2021

Codecov Report

Merging #633 (c021e0d) into main (5f93ab4) will increase coverage by 0.24%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##               main     #633      +/-   ##
============================================
+ Coverage     89.97%   90.21%   +0.24%     
- Complexity     3016     3025       +9     
============================================
  Files           395      395              
  Lines         11825    11825              
  Branches       1478     1480       +2     
============================================
+ Hits          10639    10668      +29     
+ Misses          606      592      -14     
+ Partials        580      565      -15     
Impacted Files Coverage Δ
...mallrye/mutiny/helpers/queues/MpscLinkedQueue.java 90.32% <0.00%> (-8.07%) ⬇️
...smallrye/mutiny/operators/multi/MultiEmitOnOp.java 89.52% <0.00%> (-0.96%) ⬇️
...java/io/smallrye/mutiny/helpers/Subscriptions.java 80.66% <0.00%> (+1.65%) ⬆️
...tiny/operators/multi/MultiBufferWithTimeoutOp.java 74.78% <0.00%> (+1.68%) ⬆️
...y/operators/multi/processors/UnicastProcessor.java 97.34% <0.00%> (+1.76%) ⬆️
...y/operators/multi/builders/IterableBasedMulti.java 84.04% <0.00%> (+2.12%) ⬆️
.../io/smallrye/mutiny/helpers/queues/DrainUtils.java 77.77% <0.00%> (+2.22%) ⬆️
...erators/multi/builders/SerializedMultiEmitter.java 83.54% <0.00%> (+2.53%) ⬆️
...rye/mutiny/converters/uni/UniToMultiPublisher.java 90.62% <0.00%> (+3.12%) ⬆️
...utiny/operators/multi/MultiWindowOnDurationOp.java 70.00% <0.00%> (+4.28%) ⬆️
... and 3 more

@Ladicek
Copy link
Contributor

Ladicek commented Jul 21, 2021

Maybe there's a command line option to skip it, but I couldn't find it in the docs

They have a skip option (https://github.com/Kotlin/dokka/blob/v1.5.0/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt#L104-L105), but don't expose a property for it :-/

@jponge
Copy link
Member

jponge commented Jul 21, 2021

Great point, thanks!

@jponge jponge added this to the 1.0.0 milestone Jul 21, 2021
@jponge jponge merged commit db2846c into smallrye:main Jul 21, 2021
@jmartisk jmartisk deleted the main-dokka branch July 21, 2021 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants