clj-commons
Review API diff reports
One of my primary goals for merging rewrite-clj v0 and rewrite-cljs into rewrite-clj v1 was to be deliberate about any API breakages. The idea was to keep breakages of public APIs at a very minimum so that users of rewrite-clj v0 and rewrite-cljs could carry merrily along with rewrite-clj v1.
To bolster confidence in the above, I generate various API diffs via from an admittedly hacky diff-apis project.
These API diffs were of great help to me during development.
Current questions:
- [ ] the AsciiDoc reports I generate are useful to me, but might not be great for general consumption. I think a typical user would be interested in what is broken and what is changed and what is new.
- [ ] I suppose I should integrate an API diff into my release workflow, but am not sure what form this should take yet.
- a rewrite-cljs user might be interested in a diff of rewrite-cljs and rewrite-clj v1 current
- a rewrite-clj v0 user might be interested in a diff of rewrite-clj v0 and rewreite-clj v1 current
- a rewrite-clj v1 user might be interested in a diff of rewrite-clj v1.x and rewrite-clj v1 current, but maybe could be covered manually by the change log.
New note: the adoc diff reports I generated have some adoc syntax that is unsupported and only happened to work. Starting with adoc v2.0.19, they won't render as intended.
Could just turf these docs at this point.