search

pulumi / pulumi-java

Java support for Pulumi
Apache License 2.0
69 stars 21 forks source link

Ignore or escape unintended javadoc comments #1271

Closed guineveresaenger closed 5 months ago

guineveresaenger commented 11 months ago

Hello!

Issue details

Pulumi-GCP v7.1.0 introduced what we believe is a spurious extra string to the description of a few resources. This string started with @pattern: and was populated to the documentation sections in the Pulumi schema and picked up by all related resources see Csharp example in all SDKs.

All SDKs build successfully and passed integration tests, so the upgrade was merged and released.

However, during the SDK publish step, the Java publish failed because Javadoc was interpreting this spurious string as a doc tag.

It would be fantastic if we could allow only a subset of expected Javadoc tags, and escape anything not on this allowlist.

Affected area/feature

SDK publication

t0yv0 commented 5 months ago

I've just reverted this in https://github.com/pulumi/pulumi-java/pull/1345 - I apologize if I'm a bit revert-happy here - the reasoning is that we found another blocker for azure builds and also a seeming regression from this change - I'm not 100% sure and it might be a separate issue and this change here was fixing the original issue as stated. However it would be nice to just get this javadoc escaping right before releasing a new version.