search

cartesi / machine-emulator

The off-chain implementation of the Cartesi Machine
GNU Lesser General Public License v3.0
58 stars 32 forks source link

Publish patch that adds generated files (uarch.bin etc) to source tree #241

Closed diegonehab closed 1 month ago

diegonehab commented 1 month ago

As we move towards providing packages for cartesi-machine-emulator for multiple platforms, we should make the job of package maintainers as easy as possible. One difficulty in building our emulator is its dependency on uarch.bin, which itself depends on a special toolchain we distribute inside a Docker image.

Instead of forcing package maintainers to deal with these issues, this PR introduces a new target, create-generated-files-patch that produces a patch add-generated-files.diff that, when applied to the source tree, introduces the files needed to build the emulator.

It also includes changes to CI that cause add-generated-files.diff file to be published as an artifact on tagged releases.

mpolitzer commented 1 month ago

Released artifacts now have mixed version / no version suffixes, can we clean this up here or on a new issue? My vote would be to remove them from the files and leave it only on the URL when downloading.

diegonehab commented 1 month ago

I think we can add the version names to the files. Or remove them. But the patch will put files without versions into the source tree. It could be another issue as well. @vfusco @edubart

edubart commented 1 month ago

Like @mpolitzer, I also vote for removing versioning of file names. Versioned filenames are becoming a pain in some scripts and also during packaging because we need to propagate versions through CI, scripts and makefiles.

diegonehab commented 1 month ago

Closed by mistake.

diegonehab commented 1 month ago

Opening again.