Integrate pkg for creating release executables#99
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This integrates Vercel's Pkg tool into the project for building single file executables of the CLI for distribution. There are arm and x86 builds for linux, macos, and windows now, the six builds are automatically uploaded as artifacts on every github release. I made a release off this branch to test this: https://github.com/Sindri-Labs/sindri-js/releases/tag/v0.0.1-alpha.44
Overall, I'm not that thrilled with Pkg, but it was the first tool I was able to get working reliably with the cross-platform builds and it seems like it's still the most popular choice for now. It's unmaintained, it has a number of bugs around filesystem access (e.g.
fs.promises.accessdoesn't work), it doesn't support ESM, and it seems to break with dual ESM/CJS modules. Some alternatives we might want to try in the future: