Add download information to README & mention significant changes #56
Conversation
|
Thanks for your interest in palantir/javapoet, @Marcono1234! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request. |
Generate changelog in
|
| - Changed package name to `com.palantir.javapoet` | ||
| - Made implementation-specific fields `private` and instead added getter methods | ||
| - Added support for record classes (`TypeSpec#recordBuilder`) | ||
| - Added support for permitted subclasses of `sealed` types (`TypeSpec.Builder#addPermittedSubclass`) |
There was a problem hiding this comment.
I fear this will fall out of date over time, but it's helpful to describe the enhancements/changes visibly in the readme, so it's worth that risk
|
thanks! |
| Gradle: | ||
|
|
||
| ```kotlin | ||
| implementation("com.palantir.javapoet:javapoet:<version>") |
There was a problem hiding this comment.
I used here and below a placeholder for the version (<version> respectively $version$). Hopefully it should be clear enough that these are placeholders, but in case you have some automatic workflow which could automatically update the README with the latest version on release, that would of course be even better.
There was a problem hiding this comment.
I like the placeholders, we use similar example syntax elsewhere. No reason to create readme churn when we release.
Our release process is heavily automated, keeping things simple keeps the releases flowing effortlessly :-)
| ======== | ||
| <p align="center"> | ||
| <a href="https://search.maven.org/artifact/com.palantir.javapoet/javapoet"><img src="https://img.shields.io/maven-central/v/com.palantir.javapoet/javapoet" alt="Maven Central Version"></a> | ||
| <a href="https://javadoc.io/doc/com.palantir.javapoet/javapoet"><img src="https://javadoc.io/badge2/com.palantir.javapoet/javapoet/javadoc.svg" alt="Javadoc Version"></a> |
There was a problem hiding this comment.
Not completely sure how useful the javadoc.io badge is. It seems large parts of the API are not documented (also a problem of the upstream project). But maybe it is useful nonetheless to at least see the publicly available types and methods.
There was a problem hiding this comment.
I don't have a strong opinion on this one :-)
Closes #54
Please let me know if you want anything changed, or if I should omit something.