Update documentation #132
Update documentation #132
Conversation
olafurpg
commented
Mar 31, 2021
olafurpg
commented
- remove mention of the native image, which we no longer upload
- reformulate the installation docs
- remove mention of the native image, which we no longer upload - reformulate the installation docs
| Use the [Coursier](https://get-coursier.io/docs/cli-installation) `bootstrap` | ||
| command to generate a local fat jar binary. The fat jar binary includes all | ||
| dependencies and does not require further access to the internet after | ||
| installation. The local fat jar will somehow need to be made available to your | ||
| CI machine. |
There was a problem hiding this comment.
imo we should supply a fat-jar as a downloadable artifact as well.
I would imagine that "if your CI does not allow downloading binaries from the internet" holds true (for security reasons), some companies (especially in certain industries) would have an auditing process involved in getting coursier approved first on top of lsif-java itself, resulting in customers who would prefer to just have a downloadable fat-jar to reduce the entry barrier.
Just my 2c after much back-n-forth with some guy online working at a financial institute looking to adopt Golang and the many hoops they have to go through to add anything new to the developer workflow.
There was a problem hiding this comment.
The instructions to generate the fat-jar are copy-pasteable commands that you can run anywhere to generate the standalone executable. My issue with uploading fat jars to GitHub releases is that it doesn't provide a clean way for users to upgrade between versions. With the coursier bootstrap command the lsif-java version number is part of the copy-pasted command.
There was a problem hiding this comment.
I can imagine that some customers will still ask to have a downloadable fatjar from GitHub releases and maybe we'll just comply because it's easier. It's not complicated to generate a fatjar in CI and upload it
There was a problem hiding this comment.
Totally, we can strongly recommend coursier for that reason. As you said, releasing fatjars is trivial enough, especially given we're already using github actions 🙂
2 participants
