Merge pull request #28 from flavorjones/flavorjones-prefer-linux-gnu

precompiled: switch from `-linux` to `-linux-gnu`

Author: flavorjones

.github/workflows/precompiled.yml

@@ -105,17 +105,17 @@ jobs:
       fail-fast: false
       matrix:
         platform:
-          - "aarch64-linux"
+          - "aarch64-linux-gnu"
           - "aarch64-linux-musl"
-          - "arm-linux"
+          - "arm-linux-gnu"
           - "arm-linux-musl"
           - "arm64-darwin" # github actions does not support this runtime, but let's build anyway
           - "x64-mingw-ucrt"
           - "x64-mingw32"
-          - "x86-linux"
+          - "x86-linux-gnu"
           - "x86-linux-musl"
           - "x86_64-darwin"
-          - "x86_64-linux"
+          - "x86_64-linux-gnu"
           - "x86_64-linux-musl"
     runs-on: ubuntu-latest
     steps:
@@ -140,13 +140,13 @@ jobs:
       fail-fast: false
       matrix:
         platform:
-          - "aarch64-linux"
+          - "aarch64-linux-gnu"
           - "aarch64-linux-musl"
-          - "arm-linux"
+          - "arm-linux-gnu"
           - "arm-linux-musl"
-          - "x86-linux"
+          - "x86-linux-gnu"
           - "x86-linux-musl"
-          - "x86_64-linux"
+          - "x86_64-linux-gnu"
           - "x86_64-linux-musl"
         ruby: ["3.0", "3.1", "3.2", "3.3"]
         include:
@@ -156,11 +156,11 @@ jobs:
           - { platform: x86-linux-musl, docker_tag: "-alpine", bootstrap: "apk add bash &&" }
           - { platform: x86_64-linux-musl, docker_tag: "-alpine", bootstrap: "apk add bash &&" }
           # declare docker platform for each platform
-          - { platform: aarch64-linux, docker_platform: "--platform=linux/arm64" }
+          - { platform: aarch64-linux-gnu, docker_platform: "--platform=linux/arm64" }
           - { platform: aarch64-linux-musl, docker_platform: "--platform=linux/arm64" }
-          - { platform: arm-linux, docker_platform: "--platform=linux/arm/v7" }
+          - { platform: arm-linux-gnu, docker_platform: "--platform=linux/arm/v7" }
           - { platform: arm-linux-musl, docker_platform: "--platform=linux/arm/v7" }
-          - { platform: x86-linux, docker_platform: "--platform=linux/386" }
+          - { platform: x86-linux-gnu, docker_platform: "--platform=linux/386" }
           - { platform: x86-linux-musl, docker_platform: "--platform=linux/386" }
     runs-on: ubuntu-latest
     steps:
@@ -174,6 +174,7 @@ jobs:
           docker run --rm -v $PWD/precompiled:/precompiled -w /precompiled \
             ${{ matrix.docker_platform }} ruby:${{ matrix.ruby }}${{ matrix.docker_tag }} \
             sh -c "
+              gem update --system &&
               ${{ matrix.bootstrap }}
               ./bin/test-gem-install gems
             "

CHANGELOG.md

@@ -1,16 +1,48 @@
 # Changelog
 
+## v0.5.next / unreleased
+
+### `precompiled`
+
+- The `precompiled` gem has switched from building `-linux` platform gems (implicit `gnu`) to explicit `-linux-gnu` platform gems, and now supports these platforms:
+  - `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_64-darwin`
+  - `x86_64-linux-gnu`
+  - `x86_64-linux-musl`
+
+
 ## v0.5.0 / 2024-01-27
 
-### Added
+### Improved
 
-- `precompiled` now supports the `arm-linux-musl` platform.
-- `precompiled` now supports the `aarch64-linux-musl` platform.
-- `precompiled` now supports the `x86-linux-musl` platform.
-- `precompiled` now supports the `x86_64-linux-musl` platform.
-- `precompiled` gem now supports Ruby 3.2 and 3.3, and drops support for Ruby 2.6 and 2.7
 - The `extconf.rb` file in `packaged_tarball` and `precompiled` now use a `ExtConf` module pattern for encapsulation.
 
+### `precompiled`
+
+- The `precompiled` gem now supports Ruby 3.2 and 3.3, and drops support for Ruby 2.6 and 2.7
+- The `precompiled` gem has added `musl` support for linux, and now supports these platforms:
+  - `aarch64-linux`
+  - `aarch64-linux-musl`
+  - `arm-linux`
+  - `arm-linux-musl`
+  - `arm64-darwin`
+  - `x64-mingw-ucrt`
+  - `x64-mingw32`
+  - `x86-linux`
+  - `x86-linux-musl`
+  - `x86_64-darwin`
+  - `x86_64-linux`
+  - `x86_64-linux-musl`
+
+
 
 ## 0.4.0 / 2022-05-19
 

precompiled/README.md

@@ -28,13 +28,18 @@ First, we need to add some features to our `Rake::ExtensionTask` in `Rakefile`:
 ``` ruby
 cross_rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
 cross_platforms = [
-  "x64-mingw32",
+  "aarch64-linux-gnu",
+  "aarch64-linux-musl",
+  "arm-linux-gnu",
+  "arm-linux-musl",
+  "arm64-darwin",
   "x64-mingw-ucrt",
-  "x86-linux",
-  "x86_64-linux",
-  "aarch64-linux",
+  "x64-mingw32",
+  "x86-linux-gnu",
+  "x86-linux-musl",
   "x86_64-darwin",
-  "arm64-darwin",
+  "x86_64-linux-gnu",
+  "x86_64-linux-musl",
 ]
 ENV["RUBY_CC_VERSION"] = cross_rubies.join(":")
 
@@ -161,6 +166,22 @@ end
 Go ahead and try it! `gem install rcee_precompiled`. If you're on windows, linux, or macos you should get a precompiled version that installs in under a second. Everyone else (hello FreeBSD people!) it'll take a few more seconds to build the vanilla gem's packaged tarball.
 
 
+### Windows notes
+
+You may have noticed that the gem for `x64-mingw32` only contains `.../3.0/precompiled.so` and not a shared library for 3.1, 3.2, or 3.3. Conversely, the gem for `x64-mingw-ucrt` does *not* contain 3.0 (but contains 3.1..3.3 inclusive).
+
+This is because the Windows installer for Ruby switched from `msvcrt` to `ucrt` for the C standard library. Rubies 3.0 and earlier use `msvcrt` but later Rubies use `ucrt`. So if you're on Ruby 3.0 on Windows, bundler will resolve your platform as `x64-mingw32`; but if you're on Ruby 3.1 or later, bundler will resolve your platform as `x64-mingw-ucrt`. See [the rubyinstaller release notes](https://rubyinstaller.org/2021/12/31/rubyinstaller-3.1.0-1-released.html) for more information.
+
+This is all taken care of for you by `rake-compiler-dock` and there's no additional work necessary to create those specialized native gems. However, you'll see this libc transition in the CI testing matrix in `.github/workflows/precompiled.yml`.
+
+
+### Linux notes
+
+On Linux, the default C library for a long time was GNU libc, and so when you see native gem platforms like `x86_64-linux` the _implied_ libc is `gnu`. However, in recent years the `musl` libc project has gotten off the ground in distributions like Alpine. Often, `musl` systems are able to run code compiled on (and for) `gnu` systems; but not always. And in those incompatible cases, users had to work around it or avoid Alpine.
+
+As of Rubygems 3.3.22, the `gem` and `bundle` tools are able to distinguish platforms by their libc type (e.g., `x86_64-linux-gnu` versus `x86_64-linux-musl`); and `rake-compiler-dock` started to be able to build `musl` native gems as of v1.5.0.
+
+
 ## Testing
 
 See [.github/workflows/precompiled.yml](../.github/workflows/precompiled.yml)

precompiled/Rakefile

@@ -8,17 +8,17 @@ require "rake_compiler_dock"
 
 cross_rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
 cross_platforms = [
-  "aarch64-linux",
+  "aarch64-linux-gnu",
   "aarch64-linux-musl",
-  "arm-linux",
+  "arm-linux-gnu",
   "arm-linux-musl",
   "arm64-darwin",
   "x64-mingw-ucrt",
   "x64-mingw32",
-  "x86-linux",
+  "x86-linux-gnu",
   "x86-linux-musl",
   "x86_64-darwin",
-  "x86_64-linux",
+  "x86_64-linux-gnu",
   "x86_64-linux-musl",
 ]
 ENV["RUBY_CC_VERSION"] = cross_rubies.join(":")
@@ -42,6 +42,11 @@ Rake::ExtensionTask.new("precompiled", rcee_precompiled_spec) do |ext|
     # remove things not needed for precompiled gems
     spec.dependencies.reject! { |dep| dep.name == "mini_portile2" }
     spec.files.reject! { |file| File.fnmatch?("*.tar.gz", file) }
+
+    if spec.platform.os == "linux"
+      # the `-gnu` suffix is not recognized in earlier versions of rubygems
+      spec.required_rubygems_version.concat([">= 3.3.22"])
+    end
   end
 end