rake-compiler-dock 1.4.0 → 1.5.0.rc1

data/Dockerfile.jruby

@@ -1,60 +1,66 @@
-FROM ubuntu:20.04@sha256:ed4a42283d9943135ed87d4ee34e542f7f5ad9ecf2f244870e23122f703f91c2
+FROM ubuntu:20.04
 
 ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get -y update && \
-    apt-get install -y curl git-core xz-utils wget unzip sudo gpg dirmngr openjdk-11-jdk-headless maven && \
+    apt-get install -y sudo wget curl git-core build-essential xz-utils unzip dirmngr && \
+    apt-get install -y openjdk-11-jdk-headless maven && \
     rm -rf /var/lib/apt/lists/*
 
-# Add "rvm" as system group, to avoid conflicts with host GIDs typically starting with 1000
-RUN groupadd -r rvm && useradd -r -g rvm -G sudo -p "" --create-home rvm && \
-    echo "source /etc/profile.d/rvm.sh" >> /etc/rubybashrc
-USER rvm
+##
+##  install rbenv and ruby-build
+##
+RUN groupadd -r rubyuser && useradd -r -g rubyuser -G sudo -p "" --create-home rubyuser
 
-RUN mkdir ~/.gnupg && \
-    echo "disable-ipv6" >> ~/.gnupg/dirmngr.conf
+ENV RBENV_ROOT=/usr/local/rbenv RBENV_RUBIES="jruby-9.4.0.0"
 
-# install rvm, RVM 1.26.0+ has signed releases, source rvm for usage outside of package scripts
-RUN gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB && \
-    (curl -L http://get.rvm.io | sudo bash) && \
-    bash -c " \
-        source /etc/rubybashrc && \
-        rvmsudo rvm cleanup all "
+# chown after running `rbenv init` because that command creates some subdirectories
+RUN git clone https://github.com/rbenv/rbenv.git      ${RBENV_ROOT} && \
+    git clone https://github.com/rbenv/ruby-build.git ${RBENV_ROOT}/plugins/ruby-build && \
+    \
+    echo "export RBENV_ROOT=/usr/local/rbenv" >> /etc/rubybashrc && \
+    echo "export PATH=$RBENV_ROOT/bin:\$PATH" >> /etc/rubybashrc && \
+    $RBENV_ROOT/bin/rbenv init - --no-rehash bash >> /etc/rubybashrc && \
+    echo "source /etc/rubybashrc" >> /etc/bashrc && \
+    echo "source /etc/rubybashrc" >> /etc/bash.bashrc && \
+    \
+    chown -R rubyuser:rubyuser ${RBENV_ROOT} && \
+    find ${RBENV_ROOT} -type d -print0 | sudo xargs -0 chmod g+sw
+ENV BASH_ENV=/etc/rubybashrc
 
-# Import patch files for ruby and gems
-COPY build/patches /home/rvm/patches/
-ENV BASH_ENV /etc/rubybashrc
 
-# install rubies and fix permissions on
+##
+##  set up rake-compiler and install bootstrap rubies
+##
+USER rubyuser
+
+# Install the bootstrap rubies
 RUN bash -c " \
+      echo 'gem: --no-ri --no-rdoc --no-document' >> ~/.gemrc && \
       export CFLAGS='-s -O3 -fno-fast-math -fPIC' && \
-      for v in jruby-9.4.0.0 ; do \
-          rvm install --binary \$v --patch \$(echo ~/patches/ruby-\$v/* | tr ' ' ','); \
+      for v in ${RBENV_RUBIES} ; do \
+        rbenv install \$v -- --disable-install-doc ; \
       done && \
-      rvm cleanup all && \
-      find /usr/local/rvm -type d -print0 | sudo xargs -0 chmod g+sw \
+      find ${RBENV_ROOT} -type d -print0 | sudo xargs -0 chmod g+w \
     "
 
+# Install rake-compiler and patch it to build and install static libraries for Linux rubies
+COPY build/patches2 /home/rubyuser/patches
 RUN bash -c " \
-      echo "gem: --no-ri --no-rdoc" >> ~/.gemrc && \
-      rvm all do gem update --system --no-document && \
-      rvm all do gem update --no-document && \
-      rvm all do gem install bundler --no-document && \
-      rvm all do gem install --no-document rake-compiler:1.2.5 && \
-      find /usr/local/rvm -type d -print0 | sudo xargs -0 chmod g+sw \
+      for v in ${RBENV_RUBIES} ; do \
+        rbenv shell \$v && \
+        gem install rake-compiler -v1.2.5 && \
+        cd ${RBENV_ROOT}/versions/\$v/lib/ruby/gems/*/gems/rake-compiler-1.2.5 && \
+        patch -p1 < /home/rubyuser/patches/rake-compiler-1.2.5/*.patch ; \
+      done \
     "
 
 # Install rake-compiler's cross rubies in global dir instead of /root
 RUN sudo mkdir -p /usr/local/rake-compiler && \
-    sudo chown rvm.rvm /usr/local/rake-compiler && \
+    sudo chown rubyuser.rubyuser /usr/local/rake-compiler && \
     ln -s /usr/local/rake-compiler ~/.rake-compiler
 
-USER root
-
-RUN bash -c "rvm alias create default jruby-9.4.0.0"
-RUN echo "rvm use jruby-9.4.0.0 > /dev/null" >> /etc/rubybashrc
 
-# Add rvm to the global bashrc
-RUN echo "source /etc/profile.d/rvm.sh" >> /etc/bash.bashrc
+USER root
 
 # Install SIGINT forwarder
 COPY build/sigfw.c /root/
@@ -66,4 +72,6 @@ COPY build/runas /usr/local/bin/
 # Install sudoers configuration
 COPY build/sudoers /etc/sudoers.d/rake-compiler-dock
 
+RUN bash -c "rbenv global jruby-9.4.0.0"
+
 CMD bash

data/Dockerfile.mri.erb

@@ -1,81 +1,59 @@
 <%
 image = case platform
-  when /x86_64-linux/ then "quay.io/pypa/manylinux2014_x86_64:latest@sha256:355ac32f868c200253f4af55d5b1a63a78593ef29ed9aaf0900b8b2f304ab772"
-  when /x86-linux/ then "quay.io/pypa/manylinux2014_i686:latest@sha256:39fb5356017e093825017cba9aea9d032c92f35a21a30d084a4dc4a0003ceaf9"
-  else "ubuntu:20.04@sha256:ed4a42283d9943135ed87d4ee34e542f7f5ad9ecf2f244870e23122f703f91c2"
+  when /x86_64-linux-gnu/ then "quay.io/pypa/manylinux2014_x86_64"
+  when /x86-linux-gnu/ then "quay.io/pypa/manylinux2014_i686"
+  else "ubuntu:20.04"
 end
 manylinux = !!(image =~ /manylinux/)
 %>
 FROM <%= image %>
 
 ##
-## RVM and native rubies
+## Install required base packages for compiling ruby
 ##
-# Install packages which rvm will require
 <% if manylinux %>
 RUN yum install -y sudo ruby less git wget curl autoconf libtool cmake gcc-c++ xz readline-devel sqlite-devel openssl-devel libffi-devel libyaml-devel
 
-# Prepare sudo and delete sudo as alias to gosu
+## Prepare sudo
 RUN rm -f /usr/local/bin/sudo && \
     groupadd -r sudo && \
     echo "%sudo  ALL=(ALL)       ALL" >> /etc/sudoers
+
 <% else %>
 ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get -y update && \
-    apt-get install -y sudo wget autoconf cmake curl git-core pkg-config build-essential xz-utils unzip gnupg2 dirmngr zlib1g-dev libreadline-dev libsqlite0-dev libssl-dev libyaml-dev libffi-dev && \
+    apt-get install -y sudo wget curl git-core build-essential xz-utils unzip dirmngr && \
+    apt-get install -y autoconf cmake pkg-config zlib1g-dev libreadline-dev libsqlite0-dev libssl-dev libyaml-dev libffi-dev && \
     rm -rf /var/lib/apt/lists/*
 <% end %>
 
-# Add "rvm" as system group, to avoid conflicts with host GIDs typically starting with 1000
-RUN groupadd -r rvm && useradd -r -g rvm -G sudo -p "" --create-home rvm
 
-# Make sure rvm and later settings are available in interactive and non-interactive shells
-RUN echo "source /etc/profile.d/rvm.sh" >> /etc/rubybashrc && \
-    echo "source /etc/rubybashrc" >> /etc/bashrc && \
-    echo "source /etc/rubybashrc" >> /etc/bash.bashrc
-ENV BASH_ENV /etc/rubybashrc
-
-USER rvm
-
-RUN mkdir ~/.gnupg && \
-    chmod 700 ~/.gnupg && \
-    echo "disable-ipv6" >> ~/.gnupg/dirmngr.conf
-
-# install rvm, RVM 1.26.0+ has signed releases, source rvm for usage outside of package scripts
-RUN gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB && \
-    (curl -L http://get.rvm.io | sudo bash) && \
-    bash -c " \
-      source /etc/rubybashrc && \
-      rvm autolibs disable && \
-      rvmsudo rvm cleanup all \
-    "
+##
+##  install rbenv and ruby-build
+##
+RUN groupadd -r rubyuser && useradd -r -g rubyuser -G sudo -p "" --create-home rubyuser
 
-# Install native rubies and fix permissions
-COPY build/patches /home/rvm/patches/
-ENV RVM_RUBIES 2.5.9 3.1.3
-RUN bash -c " \
-      export CFLAGS='-s -O3 -fno-fast-math -fPIC' && \
-      for v in ${RVM_RUBIES} ; do \
-        rvm install \$v --patch \$(echo ~/patches/ruby-\$v/* | tr ' ' ','); \
-      done && \
-      rvm cleanup all && \
-      find /usr/local/rvm -type d -print0 | sudo xargs -0 chmod g+sw \
-    "
+ENV RBENV_ROOT=/usr/local/rbenv RBENV_RUBIES="2.5.9 3.1.3"
+
+# chown after running `rbenv init` because that command creates some subdirectories
+RUN git clone https://github.com/rbenv/rbenv.git      ${RBENV_ROOT} && \
+    git clone https://github.com/rbenv/ruby-build.git ${RBENV_ROOT}/plugins/ruby-build && \
+    \
+    echo "export RBENV_ROOT=/usr/local/rbenv" >> /etc/rubybashrc && \
+    echo "export PATH=$RBENV_ROOT/bin:\$PATH" >> /etc/rubybashrc && \
+    $RBENV_ROOT/bin/rbenv init - --no-rehash bash >> /etc/rubybashrc && \
+    echo "source /etc/rubybashrc" >> /etc/bashrc && \
+    echo "source /etc/rubybashrc" >> /etc/bash.bashrc && \
+    \
+    chown -R rubyuser:rubyuser ${RBENV_ROOT} && \
+    find ${RBENV_ROOT} -type d -print0 | sudo xargs -0 chmod g+sw
+ENV BASH_ENV=/etc/rubybashrc
 
-RUN bash -c " \
-      echo "gem: --no-ri --no-rdoc" >> ~/.gemrc && \
-      rvm all do gem update --system --no-document && \
-      rvm all do gem update --no-document && \
-      rvm all do gem install bundler --no-document && \
-      find /usr/local/rvm -type d -print0 | sudo xargs -0 chmod g+sw \
-    "
 
 ##
-## Cross compilers
+## Install cross compilers
 ##
-USER root
-
-<% if platform=~/x64-mingw-ucrt/ %>
+<% if platform =~ /x64-mingw-ucrt/ %>
 COPY --from=larskanis/mingw64-ucrt:20.04 \
     /build/binutils-mingw-w64-x86-64_2.34-6ubuntu1.3+8.8_amd64.deb \
     /build/g++-mingw-w64-x86-64_9.3.0-17ubuntu1~20.04+22~exp1ubuntu4_amd64.deb \
@@ -86,14 +64,18 @@ COPY --from=larskanis/mingw64-ucrt:20.04 \
     /debs/
 RUN dpkg -i /debs/*.deb
 
+<% elsif platform =~ /linux-musl/ %>
+COPY build/mk_musl_cross.sh /tmp
+RUN /tmp/mk_musl_cross.sh <%= target %>
+
 <% elsif !manylinux %>
 RUN apt-get -y update && \
     apt-get install -y <%
-if platform=~/darwin/        %> clang python lzma-dev libxml2-dev libssl-dev libc++-10-dev <% end %><%
-if platform=~/aarch64-linux/ %> gcc-aarch64-linux-gnu g++-aarch64-linux-gnu <% end %><%
-if platform=~/arm-linux/     %> gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf <% end %><%
-if platform=~/x86-mingw32/   %> gcc-mingw-w64-i686 g++-mingw-w64-i686 <% end %><%
-if platform=~/x64-mingw32/   %> gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 <% end %> && \
+if platform =~ /darwin/        %> clang python lzma-dev libxml2-dev libssl-dev libc++-10-dev <% end %><%
+if platform =~ /aarch64-linux-gnu/ %> gcc-aarch64-linux-gnu g++-aarch64-linux-gnu <% end %><%
+if platform =~ /arm-linux-gnu/     %> gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf <% end %><%
+if platform =~ /x86-mingw32/   %> gcc-mingw-w64-i686 g++-mingw-w64-i686 <% end %><%
+if platform =~ /x64-mingw32/   %> gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 <% end %> && \
     rm -rf /var/lib/apt/lists/*
 <% end %>
 
@@ -103,34 +85,43 @@ COPY build/mk_i686.rb /root/
 RUN /root/mk_i686.rb
 <% end %>
 
-<% if platform=~/darwin/ %>
-COPY build/mk_osxcross.sh /home/rvm
-RUN /home/rvm/mk_osxcross.sh
+<% if platform =~ /darwin/ %>
+COPY build/mk_osxcross.sh /tmp
+RUN /tmp/mk_osxcross.sh
 <% end %>
 
 
 ##
-## Cross-compile rubies
+##  set up rake-compiler and install bootstrap rubies
 ##
-USER rvm
+USER rubyuser
 
-RUN bash -c "rvm all do gem install --no-document rake-compiler:1.2.5"
-
-# Install rake-compiler's cross rubies in global dir instead of /root
-RUN sudo mkdir -p /usr/local/rake-compiler && \
-    sudo chown rvm.rvm /usr/local/rake-compiler && \
-    ln -s /usr/local/rake-compiler ~/.rake-compiler
+# Install the bootstrap rubies
+RUN bash -c " \
+      echo 'gem: --no-ri --no-rdoc --no-document' >> ~/.gemrc && \
+      export CFLAGS='-s -O3 -fno-fast-math -fPIC' && \
+      for v in ${RBENV_RUBIES} ; do \
+        rbenv install \$v -- --disable-install-doc ; \
+      done && \
+      find ${RBENV_ROOT} -type d -print0 | sudo xargs -0 chmod g+w \
+    "
 
-# Patch rake-compiler to build and install static libraries for Linux rubies
-COPY build/patches2 /home/rvm/patches/
+# Install rake-compiler and patch it to build and install static libraries for Linux rubies
+COPY build/patches2 /home/rubyuser/patches
 RUN bash -c " \
-      for v in ${RVM_RUBIES} ; do \
-        cd /usr/local/rvm/gems/ruby-\$v/gems/rake-compiler-1.2.5 && \
-        echo applying patches to ruby-\$v /home/rvm/patches/rake-compiler-1.2.5/*.patch && \
-        ( git apply /home/rvm/patches/rake-compiler-1.2.5/*.patch || true ) \
+      for v in ${RBENV_RUBIES} ; do \
+        rbenv shell \$v && \
+        gem install rake-compiler -v1.2.5 && \
+        cd ${RBENV_ROOT}/versions/\$v/lib/ruby/gems/*/gems/rake-compiler-1.2.5 && \
+        patch -p1 < /home/rubyuser/patches/rake-compiler-1.2.5/*.patch ; \
       done \
     "
 
+# Install rake-compiler's cross rubies in global dir instead of /root
+RUN sudo mkdir -p /usr/local/rake-compiler && \
+    sudo chown rubyuser.rubyuser /usr/local/rake-compiler && \
+    ln -s /usr/local/rake-compiler ~/.rake-compiler
+
 <%
 #
 # Build ruby versions prior to ruby2_keywords using ruby-2.5
@@ -139,7 +130,7 @@ RUN bash -c " \
 # Note that parallel builds of ruby with make flag `-j` are often flaky, see
 # https://bugs.ruby-lang.org/issues/18506
 #
-axrubies = if platform =~ /x64-mingw-ucrt/
+xrubies_build_plan = if platform =~ /x64-mingw-ucrt/
   [
     # Rubyinstaller-3.1.0+ is platform x64-mingw-ucrt
     ["3.3.0-rc1:3.2.0:3.1.0", "3.1.3"],
@@ -157,35 +148,33 @@ else
   ]
 end
 
-axrubies.each do |xrubies, rvm| %>
-ENV XRUBIES <%= xrubies %>
+strip = '-s' if platform !~ /darwin/
 
-<% strip = '-s' if platform !~ /darwin/ %>
-# Build xruby versions, then cleanup all build artifacts
+xrubies_build_plan.each do |xrubies, bootstrap_ruby_version| %>
 RUN bash -c " \
-      rvm use <%= rvm %> && \
-      export CPPFLAGS='<%= "-D__USE_MINGW_ANSI_STDIO=1" if platform=~/x64-mingw-ucrt/ %>' && \
+      rbenv shell <%= bootstrap_ruby_version %> && \
+      export CPPFLAGS='<%= "-D__USE_MINGW_ANSI_STDIO=1" if platform =~ /x64-mingw-ucrt/ %>' && \
       export CFLAGS='-O1 -fno-omit-frame-pointer -fno-fast-math -fstack-protector-strong <%= strip %>' && \
       export LDFLAGS='-pipe <%= strip %>' && \
       <%= "export LIBS='-l:libssp.a' &&" if platform =~ /mingw/ %> \
       <%= "export CC=#{target}-clang &&" if platform =~ /darwin/ %> \
       export MAKE='make V=1' && \
-      rake-compiler cross-ruby VERSION=$XRUBIES HOST=<%= target %> && \
-      rm -rf ~/.rake-compiler/builds ~/.rake-compiler/sources && \
-      find /usr/local/rvm -type d -print0 | sudo xargs -0 chmod g+sw \
+      rake-compiler cross-ruby VERSION=<%= xrubies %> HOST=<%= target %> && \
+      rm -rf ~/.rake-compiler/builds ~/.rake-compiler/sources \
     "
 <% end %>
+# "
 
-<% if platform=~/linux/ %>
+<% if platform =~ /linux/ %>
 # Avoid linking against libruby shared object.
 # See also https://github.com/rake-compiler/rake-compiler-dock/issues/13
 RUN find /usr/local/rake-compiler/ruby/*linux*/ -name libruby.so | xargs rm
 RUN find /usr/local/rake-compiler/ruby/*linux*/ -name libruby-static.a | while read f ; do cp $f `echo $f | sed s/-static//` ; done
 RUN find /usr/local/rake-compiler/ruby/*linux*/ -name libruby.a | while read f ; do ar t $f | xargs ar d $f ; done
-RUN find /usr/local/rake-compiler/ruby/*linux*/ -name mkmf.rb | while read f ; do sed -i ':a;N;$!ba;s/TRY_LINK = [^\n]*\n[^\n]*\n[^\n]*LOCAL_LIBS)/& -lruby-static -lpthread -lrt -ldl <% if platform=~/x86/ %> -lcrypt <% end %>/' $f ; done
+RUN find /usr/local/rake-compiler/ruby/*linux*/ -name mkmf.rb | while read f ; do sed -i ':a;N;$!ba;s/TRY_LINK = [^\n]*\n[^\n]*\n[^\n]*LOCAL_LIBS)/& -lruby-static -lpthread -lrt -ldl <% if platform =~ /x86/ %> -lcrypt <% end %>/' $f ; done
 <% end %>
 
-<% if platform=~/mingw/ %>
+<% if platform =~ /mingw/ %>
 # RubyInstaller doesn't install libgcc -> link it static.
 RUN find /usr/local/rake-compiler/ruby/*mingw*/ -name rbconfig.rb | while read f ; do sed -i 's/."LDFLAGS". = "/&-static-libgcc /' $f ; done
 # Raise Windows-API to Vista (affects ruby < 2.6 only)
@@ -197,7 +186,7 @@ RUN find /usr/local/rake-compiler/ruby -name lib*-ruby*.dll.a | while read f ; d
 # ruby-2.5 links to libcrypt, which isn't necessary for extensions
 RUN find /usr/local/rake-compiler/ruby -name rbconfig.rb | while read f ; do sed -i 's/-lcrypt//' $f ; done
 
-<% if platform=~/darwin/ %>
+<% if platform =~ /darwin/ %>
 # ruby-3.2+ on darwin links with `-bundle_loader`,
 # - see https://github.com/rake-compiler/rake-compiler-dock/issues/87
 # - note that we do this for "3.[2-9].0" to match rubies 3.2 and later
@@ -206,15 +195,13 @@ RUN find /usr/local/rake-compiler/ruby/*/*/lib/ruby/3.[2-9].0* -name rbconfig.rb
     while read f ; do sed -i 's/\["EXTDLDFLAGS"\] = "/&-Wl,-flat_namespace /' $f ; done
 <% end %>
 
+
 ##
 ##  Final adjustments
 ##
 USER root
 
-# Fix paths in rake-compiler/config.yml
-RUN sed -i -- "s:/root/.rake-compiler:/usr/local/rake-compiler:g" /usr/local/rake-compiler/config.yml
-
-<% if platform=~/mingw/ %>
+<% if platform =~ /mingw/ %>
 # Install wrappers for strip commands as a workaround for "Protocol error" in boot2docker.
 COPY build/strip_wrapper_vbox /root/
 RUN mv /usr/bin/<%= target %>-strip /usr/bin/<%= target %>-strip.bin && \
@@ -242,12 +229,13 @@ RUN echo "export PATH=\$DEVTOOLSET_ROOTPATH/usr/bin:\$PATH" >> /etc/rubybashrc
 RUN for f in addr2line gcc gcov-tool ranlib ar dwp gcc-ranlib nm readelf as elfedit gcc-ar gprof objcopy size c++filt g++ gcov ld objdump strings cpp gcc-nm pkg-config strip ; do ln -sf $DEVTOOLSET_ROOTPATH/usr/bin/$f $DEVTOOLSET_ROOTPATH/usr/bin/<%= target %>-$f ; done
 
 # Use builtin functions of newer gcc to avoid linker issues on Musl based Linux
+# TODO: remove in v1.6.0 once musl builds have been out for full minor release cycle, see 864be5b2
 COPY build/math_h.patch /root/
 RUN cd /usr/include/ && \
     patch -p1 < /root/math_h.patch
 <% end %>
 
-<% if platform=~/arm64-darwin/ %>
+<% if platform =~ /arm64-darwin/ %>
 # Add a arm64 darwin target as alternative to aarch64
 RUN grep -E 'rbconfig-aarch64-darwin' /usr/local/rake-compiler/config.yml | sed 's/rbconfig-[a-z0-9_]*-darwin/rbconfig-<%= platform %>/' >> /usr/local/rake-compiler/config.yml
 <% end %>
@@ -259,15 +247,12 @@ RUN gcc $HOME/sigfw.c -o /usr/bin/sigfw
 # Install user mapper
 COPY build/runas /usr/bin/
 COPY build/rcd-env.sh /etc/profile.d/
-RUN echo "source /etc/profile.d/rcd-env.sh" >> /etc/rubybashrc
+RUN echo 'source /etc/profile.d/rcd-env.sh' >> /etc/rubybashrc
 
 # Install sudoers configuration
 COPY build/sudoers /etc/sudoers.d/rake-compiler-dock
 
-RUN bash -c " \
-      rvm alias create default 3.1.3 && \
-      rvm use default \
-    "
+RUN bash -c "rbenv global 3.1.3"
 
 ENV RUBY_CC_VERSION 3.3.0:3.2.0:3.1.0:3.0.0:2.7.0:2.6.0:2.5.0:2.4.0
 

data/History.md

@@ -1,8 +1,35 @@
-1.4.0 / 2023-12-26
+# v1.5.0.rc1 / prerelease 2024-01-26
+
+## Notable changes
+
+### First-class Linux `musl` libc support
+
+* Add Linux musl cross build targets `aarch64-linux-musl`, `arm-linux-musl`, `x86-linux-musl`, and `x86_64-linux-musl`. #75, #111 (@flavorjones)
+* Add Linux cross build targets `aarch64-linux-gnu`, `arm-linux-gnu`, `x86-linux-gnu`, and `x86_64-linux-gnu`. #111 (@flavorjones)
+* The cross build targets `aarch64-linux`, `arm-linux`, `x86-linux`, and `x86_64-linux` are now aliases for the `*-linux-gnu` targets. #111 (@flavorjones)
+
+Please read the README for more details.
+
+
+## Improvements
+
+* Predefined user and group list is more complete, and represents the union of users and groups
+  across all RCD images.
+
+
+## Changes
+
+* Replace `rvm` with `rbenv` and `ruby-build` in the build containers.
+  - `rvm` has been replaced by `rbenv` and `ruby-build`
+    - no longer applying sendfile patches to bootstrap rubies
+    - no longer updating gems belonging to the bootstrap rubies
+  - user `rvm` no longer exists, replaced by `rubyuser`
+
+
+1.4.0 / 2023-12-27
 ------------------
 
 * Add Ruby 3.3.0-rc1 cross-compilation support. #109, #105 (@flavorjones)
-* Add Ruby 3.3.0-preview3 cross-compilation support. #105 (@flavorjones)
 * Update to rake-compiler 1.2.5. #108 (@flavorjones)
 
 
@@ -49,7 +76,7 @@
 * Fix testing for ruby C-API functions in mkmf. #65, #67
 * Use openjdk 11 to make maven work on ubuntu 20.04. #64
 * Remove x86_64-w64-mingw32-pkg-config from the x64-mingw-ucrt image. #63
-* Add a patch for math.h to use gcc builtins and to improve compat with musl based systems. #42
+* Add a patch for math.h to use gcc builtins and to improve compat with `musl` libc-based systems. #42
 
 
 1.2.0 / 2022-01-04

data/README.md

@@ -10,6 +10,43 @@ This is kind of successor of [rake-compiler-dev-box](https://github.com/tjschuck
 It is wrapped as a gem for easier setup, usage and integration and is based on lightweight Docker containers.
 It is also more reliable, since the underlying docker images are versioned and immutable.
 
+## Supported platforms
+
+The following platforms are supported for cross-compilation by rake-compiler-dock:
+
+- `aarch64-linux` and `aarch64-linux-gnu`
+- `aarch64-linux-musl`
+- `arm-linux` and `arm-linux-gnu`
+- `arm-linux-musl`
+- `arm64-darwin`
+- `jruby`
+- `x64-mingw-ucrt`
+- `x64-mingw32`
+- `x86-linux` and `x86-linux-gnu`
+- `x86-linux-musl`
+- `x86-mingw32`
+- `x86_64-darwin`
+- `x86_64-linux` and `x86_64-linux-gnu`
+- `x86_64-linux-musl`
+
+### Windows
+
+`x64-mingw-ucrt` should be used for Ruby 3.1 and later on windows. `x64-mingw32` should be used for Ruby 3.0 and earlier. This is to match the [changed platform of RubyInstaller-3.1](https://rubyinstaller.org/2021/12/31/rubyinstaller-3.1.0-1-released.html).
+
+### GNU and Musl
+
+Platform names with a `*-linux` suffix are aliases for `*-linux-gnu`, since the Rubygems default is to assume `gnu` if no libc is specified.
+
+Some C extensions may not require separate GNU and Musl builds, in which case it's acceptable to ship a single `*-linux` gem to cover both platforms.
+
+The `*-linux-gnu` and `*-linux-musl` platform name suffixes require Rubygems 3.3.22 or later (or Bundler 2.3.21 or later) at installation time. Ruby version 3.0 and later ship with a sufficient Rubygems version, but versions compatible with earlier Rubies are:
+
+- ruby: "2.7", rubygems: "3.4.22"
+- ruby: "2.6", rubygems: "3.4.22"
+- ruby: "2.5", rubygems: "3.3.26"
+- ruby: "2.4", rubygems: "3.3.26"
+
+
 ## Installation
 
 Install docker [following the instructions on the docker website](https://docs.docker.com/engine/install/) ... or install [docker-toolbox for Windows and OSX](https://github.com/docker/toolbox/releases) or boot2docker on [Windows](https://github.com/boot2docker/windows-installer/releases) or [OS X](https://github.com/boot2docker/osx-installer/releases) .
@@ -37,6 +74,8 @@ exttask = Rake::ExtensionTask.new('my_extension', my_gem_spec) do |ext|
 end
 ```
 
+where you should choose your platforms from the list in the "Supported platforms" section.
+
 See below, how to invoke cross builds in your Rakefile.
 
 Additionally it may also be used to build ffi based binary gems like [libusb](https://github.com/larskanis/libusb), but currently doesn't provide any additional build helpers for this use case, beyond docker invocation and cross compilers.
@@ -44,9 +83,6 @@ Additionally it may also be used to build ffi based binary gems like [libusb](ht
 ### Interactive Usage
 
 Rake-compiler-dock offers the shell command `rake-compiler-dock` and a [ruby API](http://www.rubydoc.info/gems/rake-compiler-dock/RakeCompilerDock) for issuing commands within the docker image, described below.
-There are dedicated images for `x86-mingw32`, `x64-mingw-ucrt`, `x64-mingw32`, `x86-linux`, `x86_64-linux`, `x86_64-darwin`, `arm64-darwin` and `jruby` targets.
-The images contain all supported cross ruby versions, with the exception of `x64-mingw32`, which has versions before 3.1 only, and `x64-mingw-ucrt`, which has only ruby-3.1+.
-This is to match the [changed platform of RubyInstaller-3.1](https://rubyinstaller.org/2021/12/31/rubyinstaller-3.1.0-1-released.html).
 
 `rake-compiler-dock` without arguments starts an interactive shell session.
 This is best suited to try out and debug a build.
@@ -68,12 +104,12 @@ To build x86 Windows and x86_64 Linux binary gems interactively, it can be calle
     user@host:$ ls pkg/*.gem
     your-gem-1.0.0.gem  your-gem-1.0.0-x86-mingw32.gem
 
-    user@host:$ RCD_PLATFORM=x86_64-linux rake-compiler-dock   # this enters a container for amd64 Linux target
+    user@host:$ RCD_PLATFORM=x86_64-linux-gnu rake-compiler-dock   # this enters a container for amd64 Linux GNU target
     user@adc55b2b92a9:$ bundle
     user@adc55b2b92a9:$ rake cross native gem
     user@adc55b2b92a9:$ exit
     user@host:$ ls pkg/*.gem
-    your-gem-1.0.0.gem  your-gem-1.0.0-x86_64-linux.gem
+    your-gem-1.0.0.gem  your-gem-1.0.0-x86_64-linux-gnu.gem
 
 Or non-interactive:
 
@@ -92,7 +128,7 @@ For Linux:
 
     sudo yum install your-package
 
-You can also choose between different executable ruby versions by `rvm use <version>` .
+You can also choose between different executable ruby versions by `rbenv shell <version>` .
 The current default is 3.1.
 
 ### JRuby support
@@ -118,10 +154,25 @@ To make the build process reproducible for other parties, it is recommended to a
 This can be done like this:
 
 ```ruby
+PLATFORMS = %w[
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x64-mingw-ucrt
+  x64-mingw32
+  x86-linux-gnu
+  x86-linux-musl
+  x86-mingw32
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+]
 task 'gem:native' do
   require 'rake_compiler_dock'
   sh "bundle package --all"   # Avoid repeated downloads of gems by using gem files from the host.
-  %w[ x86-mingw32 x64-mingw-ucrt x64-mingw32 x86-linux x86_64-linux arm-linux aarch64-linux x86_64-darwin arm64-darwin ].each do |plat|
+  PLATFORMS.each do |plat|
     RakeCompilerDock.sh "bundle --local && rake native:#{plat} gem", platform: plat
   end
   RakeCompilerDock.sh "bundle --local && rake java gem", rubyvm: :jruby
@@ -187,10 +238,10 @@ jobs:
     name: "native-gem"
     runs-on: ubuntu-latest
     container:
-      image: "ghcr.io/rake-compiler/rake-compiler-dock-image:1.2.2-mri-x86_64-linux"
+      image: "ghcr.io/rake-compiler/rake-compiler-dock-image:1.2.2-mri-x86_64-linux-gnu"
     steps:
       - uses: actions/checkout@v2
-      - run: bundle install && bundle exec rake gem:x86_64-linux:rcd
+      - run: bundle install && bundle exec rake gem:x86_64-linux-gnu:rcd
       - uses: actions/upload-artifact@v2
         with:
           name: native-gem
@@ -198,7 +249,7 @@ jobs:
           retention-days: 1
 ```
 
-Where the referenced rake task might be defined by:
+Where the referenced rake task might be defined by something like:
 
 ``` ruby
 cross_platforms = ["x64-mingw32", "x86_64-linux", "x86_64-darwin", "arm64-darwin"]
@@ -223,7 +274,7 @@ For an example of rake tasks that support this style of invocation, visit https:
 
 OCI images snapshotted from `main` are published weekly to Github Container Registry with the string "snapshot" in place of the version number in the tag name, e.g.:
 
-- `ghcr.io/rake-compiler/rake-compiler-dock-image:snapshot-mri-x86_64-linux`
+- `ghcr.io/rake-compiler/rake-compiler-dock-image:snapshot-mri-x86_64-linux-gnu`
 
 These images are intended for integration testing. They may not work properly and should not be considered production ready.
 
@@ -237,7 +288,7 @@ The following variables are recognized by rake-compiler-dock:
 * `RCD_RUBYVM` - The ruby VM and toolchain to be used.
     Must be one of `mri`, `jruby`.
 * `RCD_PLATFORM` - The target rubygems platform.
-    Must be a space separated list out of `x86-mingw32`, `x64-mingw-ucrt`, `x64-mingw32`, `x86-linux`, `x86_64-linux`, `arm-linux`, `aarch64-linux`, `x86_64-darwin` and `arm64-darwin`.
+    Must be a space separated list out of the platforms listed under "Supported platforms" above.
     It is ignored when `rubyvm` is set to `:jruby`.
 * `RCD_IMAGE` - The docker image that is downloaded and started.
     Defaults to "ghcr.io/rake-compiler/rake-compiler-dock-image:IMAGE_VERSION-PLATFORM" with an image version that is determined by the gem version.