Changes between Version 2 and Version 3 of RepeatableBuilds

Dec 10, 2015, 12:25:22 PM (8 years ago)
raimue (Rainer Müller)



  • RepeatableBuilds

    v2 v3  
    1 Port builds should be repeatable and predictable. That means that if a user installs a port today, and another user installs the port tomorrow, and the Portfile has not been changed in between, both users should get the same software (allowing of course for possible differences due to architecture or OS X version).
    3 == Compiler ==
    5 Ports should [wiki:UsingTheRightCompiler use the right compiler].
    7 == Dependencies ==
    9 When a software package has a mandatory dependency on another package, and that other package is missing, it's easy to see, because usually the configure phase will exit with an error explaining what was missing, and then that dependency can be added to the portfile. But some software packages have optional dependencies: they'll use the dependency if it's already installed, but won't complain if it's not installed; they'll just omit that functionality. These situations are easier for a maintainer to inadvertently overlook, and if so, some users who install the port will have the optional functionality and some won't, based on whether they happened to already have the optional dependency installed. If the optional dependency's library version number increases, that may even cause the port to be broken until it's rebuilt. Or if the port is distributable, then they may get the binary built by our buildbot, which doesn't have any extraneous ports installed, so any optional functionalities won't be there.
    11 We don't want this, so when such a situation is discovered, either the dependency should be unconditionally added to the portfile and the revision increased, or the software should be informed to never use the optional functionality, even if the optional dependency is already installed. In the latter case, a variant could also be added to let the user choose whether to add the functionality or not.
    13 == Fetching the source from a repository ==
    15 Wherever possible, ports should fetch from compressed distfiles, which our network of servers will automatically mirror. When this is not possible, a port might fetch directly from the developers' repository. When fetching from a repository, it is important to specify a specific revision or commit to fetch. It is not acceptable to fetch from the head or tip of the trunk or of a specific branch, because if two users install the same version of the port a day apart, and in between the developers commit a new revision to their repository, the two users will have different software, but no outward indication that this is the case. Also, the user who installed the port first will have no indication that new software is available, and even if they knew that a new version was available, they would have to forcibly rebuild the port to get it, since MacPorts would not consider the port outdated. Even that might not work: if the port is distributable, our buildbot will build a binary package the moment it is committed, and users might forevermore get that version, even if newer versions are available upstream. Finally, users who do manage to get newer commits are thus getting software that nobody at MacPorts has tested before; we always want at least one person (the MacPorts committer) to have verified that software at least builds and ideally works correctly and does not have any adverse side-effects (malware perhaps?) before making it available to other MacPorts users.
    17 The solution is to always specify a specific known-good commit of the upstream repository to use. When new software is available upstream, the portfile can be updated to reference that new version.
     1Moved to ReproducibleBuilds.