Publish Error Prone compatibility matrix on website #938
Conversation
|
Looks good. No mutations were possible for these changes. |
| # An overview of Error Prone Support releases, along with compatible Error | ||
| # Prone releases. This data was generated by `generate-version-compatibility-overview.sh`. |
There was a problem hiding this comment.
This script takes quite some time to run (and that'll go up due to it's quadratic nature 🙊), so committing the result is the only realistic option.
| | [{{ release.version }}](https://github.com/PicnicSupermarket/error-prone-support/releases/tag/v{{ release.version }}) | {% | ||
| for version in release.compatible -%} | ||
| [{{ version }}](https://github.com/google/error-prone/releases/tag/v{{ version }}){% unless forloop.last %}, {% endunless %} | ||
| {%- endfor %} | |
There was a problem hiding this comment.
The formatting is funny here, but that seemed necessary to make sure that a proper Markdown table is produced. Suggestions welcome.
There was a problem hiding this comment.
github doesn't really seem to properly display this? 🤔
There was a problem hiding this comment.
So yeah, this PR is a bit "fake": we don't currently deploy the website from the master branch, but instead from the website branch. Not all logic there has been properly cleaned up yet, and some of the changes there are really not acceptable on master; hence the split.
But... these changes in this PR are also part of that branch, so you can see the result live on the internet.
| [^1]: Note that this [does not prove][source-binary-compat] that the Error Prone Support and Error Prone versions are _binary_ compatible. This limitation does not appear to be an issue in practice. | ||
| [^2]: The approach taken here may yield false negatives, because a reported incompatibility may merely be due to a test API incompatibility. |
There was a problem hiding this comment.
Wrapping these lines breaks the formatting 🤷
Stephan202
force-pushed
the
sschroevers/document-error-prone-compatibility
branch
from
02142a8 to
a7ee352
Compare
|
Looks good. No mutations were possible for these changes. |
The new `website/generate-version-compatibility-overview.sh` script tests all combinations, and stores the result in a Jekyll data file. Resolves #724.
rickie
force-pushed
the
sschroevers/document-error-prone-compatibility
branch
from
a7ee352 to
8dc234a
Compare
|
Looks good. No mutations were possible for these changes. |
|
There was a problem hiding this comment.
Awesome work @Stephan202 , really cool script 🚀 !
Thanks for the review @Venorcis!
This resolves #724 and addresses a discussion in #935. The result can be seen here.
Suggested commit message: