Incoherent documentation of default values

[SimonMarquis]

Describe your use-case which is not covered by existing documentation.

• validationTimeout is 10 minutes
  

  nmcp/nmcp/src/main/kotlin/nmcp/CentralPortalOptions.kt

  Lines 48 to 50 in 053a55e

  	* Default: 10 minutes.
  	*/
  	abstract val validationTimeout: Property<Duration>

  
  

  nmcp/nmcp/src/main/kotlin/nmcp/internal/task/nmcpPublishWithPublisherApi.kt

  Line 84 in 053a55e

  val timeout1 = validationTimeoutSeconds?.seconds ?: 10.minutes

• publishingTimeout is 0 minutes
  

  nmcp/nmcp/src/main/kotlin/nmcp/CentralPortalOptions.kt

  Lines 64 to 66 in 053a55e

  	* Default: 10 minutes.
  	*/
  	abstract val publishingTimeout: Property<Duration>

  
  

  nmcp/nmcp/src/main/kotlin/nmcp/internal/task/nmcpPublishWithPublisherApi.kt

  Line 89 in 053a55e

  val timeout2 = publishingTimeoutSeconds?.seconds ?: 0.seconds

Is the documentation wrong, or is the code wrong?

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Are you interested in contributing to the documentation?

No response

[martinbonnin]

Is the documentation wrong, or is the code wrong?

I consider this to be a bad KDoc copy/pasta. Rationale for not waiting for publishing is that:

• it can be very long (~20min, even for a small project such as nmcp).
• it can never fail. Once validation is successful, I have never seen publishing fail so keeping a CI machine alive for this feels a bit silly.

All in all, I wish we could make the validation timeout a bit smarter, see #132

For the publishing timeout, do you think it'd make sense to wait? It felt like waiting didn't bring much value there but maybe it does?

[SimonMarquis]

Yeah, I think that only the "validation" step is something useful to be aware of it failing because it probably mean someone screwed up somewhere and need to fix the build and re-submit a new deployment.
For the "publishing" step, it's like waiting for a CDN to update... By the way, there are other tools for this that already exist for this exact purpose:
👀 https://github.com/JakeWharton/dependency-watch

[martinbonnin]

Exactly. Waiting for the CDN is best done outside the CI job. I'll close this issue.