Create Semantic Releases with Binaries as Assets

[geographika]

As discussed with @jansule and raised in #346 this pull request aims to add automatic semantic releases for the geostyler-cli.

The changes are mainly copied from the main geostyler project:

• https://github.com/geostyler/geostyler/blob/main/.github/workflows/release.yml
• https://github.com/geostyler/geostyler/blob/main/.releaserc
• https://github.com/geostyler/geostyler/blob/main/.commitlintrc.js
• https://github.com/geostyler/geostyler/blob/main/package.json#L94-L100
• https://github.com/geostyler/geostyler/blob/main/package.json#L139

Some notes for reference:

• it was surprisingly hard to try and get a cross platform method for renaming and then zipping up the various binaries. zlib doesn't fit this use case so I had to add another dev dependency: https://www.npmjs.com/package/adm-zip
• a successful run of the workflow can be seen on my fork at https://github.com/geographika/geostyler-cli/actions/runs/4960900228
• https://github.com/vercel/pkg is used to create binaries for Windows, Linux, and MacOS. I've only really tested the Windows version which runs fine. I'm not sure what versions of "Linux" would be supported.
• The configuration for pkg has been added to package.json, along with the additional build commands. Strangely lots of warnings are created using this approach which are not displayed when running pkg dist/src/index.js --output geostyler.
• The warnings can be seen here and relate the OL files. The client doesn't actually use "geostyler-openlayers-parser": "^4.1.2", so maybe the dependency could be removed?

Warning Babel parse has failed: import.meta may appear only with 'sourceType: "module"' (5:43) Warning Failed to make bytecode node18-x64 for file /snapshot/geostyler-cli/node_modules/ol/index.js Warning Failed to make bytecode node18-x64 for file /snapshot/geostyler-cli/node_modules/terminal-image/index.js

• the package-binaries.js script takes care of renaming each of the binaries to geostyler-cli (or geostyler-cli.exe on Windows) and then zipping up the file. This means all binaries have the same name. Final output looks as below:

• package-lock.json has lots of changes, but as I understand it should still be checked in

TODO:

• Add the actual zips to the assets and test and complete the final steps in release.yml. This requires secrets and a NPM token? I'm also not familiar with exactly how the release notes should be generated. Help on completing this step appreciated!

[jansule]

The configuration for pkg has been added to package.json, along with the additional build commands. Strangely lots of warnings are created using this approach which are not displayed when running pkg dist/src/index.js --output geostyler.

I think I had similar warnings (but way less) on my local setup. We should take a closer look at it, but you might be right regarding removing the openlayers parser as a dependency.

[dnlkoch]

:tada: This PR is included in version 3.1.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: