Rex icon indicating copy to clipboard operation
Rex copied to clipboard

Provide build artifacts

Open ferki opened this issue 5 years ago • 0 comments

User story

As a package maintainer, I would like to use pre-built artifacts for packaging, so I can avoid pulling in the whole authoring environment as build dependencies.

Describe the solution you'd like

The idea is to save the build results for each successfully tested commit of the default git branch, and ask Travis CI to publish them somewhere (e.g. in a separate branch, or repo). That way package maintainers may decide between using these pre-built "git builds" as installation source, packaging the whole build system, or anything in between (e.g. drop the author plugins, and only package the rest).

  • [ ] idea 1: save build directory (or tarball) of tagged releases as standard GitHub Releases
  • [ ] idea 2: save build directory (or tarball) of each successfully built commit from the default git branch ("bleeding edge builds")

Describe alternatives you've considered

See the discussion #1304. That is originally about implementing the patching logic which can be executed during package build time, but also touches using vendor-specific dist.ini files, or just maintaining the diff for them (ideally the discussion could have taken place in an issue first, but I don't want to duplicate everything by copying text over here now).

I'm also not comfortable bringing in vendor-specific packaging details into the project scope, mostly because if a vendor would like to build Rex differently than upstream, that is great, but I think it still primarily is a decision and concern of the vendor. That may be rephrased as: "we supply how we intend Rex to be built; that's completely fine if you have a different opinion, and feel free to build it differently, but that's your choice".

Additional context

The build process of Rex relies on various Dist::Zilla plugins. Some of it is important only for authors (people who modify Rex itself), and strictly speaking only the rest are important for end-users (people who want to build and install Rex). Furthermore, there's a distinction between tagged releases and building from the default git branch.

OS packages for tagged releases can use pre-built sources e.g. from CPAN (while it would also be nice to upload these tarballs as GitHub Releases as well). But if you'd like write a package that builds Rex from source (like a specific commit or branch), the whole list of build dependencies has to be pulled in. That might impose a prohibitive cost on the packaging side, with relatively low returns in exchange (e.g. using Test::PerlTidy to ensure that the source code is tidy: it's mostly important for authors to keep the code style consistent, but less important for end-users who only want to run Rex).

ferki avatar Aug 02 '20 11:08 ferki