Add precompilation workflow

Author: jonatanklosko

.github/workflows/release.yml

@@ -0,0 +1,110 @@
+name: Release
+on:
+  push:
+    tags:
+      - "v*.*.*"
+permissions:
+  contents: write
+jobs:
+  linux:
+    runs-on: ubuntu-20.04
+    env:
+      MIX_ENV: prod
+      ELIXIR_VERSION: "1.15.3"
+    strategy:
+      matrix:
+        otp_version: ["25.3"]
+    name: Linux x86_64 (${{ matrix.otp_version }})
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp_version }}
+          elixir-version: ${{ env.ELIXIR_VERSION }}
+      - name: Install system dependecies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential automake autoconf pkg-config bc m4 unzip zip \
+            gcc g++ \
+            gcc-i686-linux-gnu g++-i686-linux-gnu \
+            gcc-aarch64-linux-gnu g++-aarch64-linux-gnu \
+            gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf \
+            gcc-riscv64-linux-gnu g++-riscv64-linux-gnu \
+            gcc-powerpc64le-linux-gnu g++-powerpc64le-linux-gnu \
+            gcc-s390x-linux-gnu g++-s390x-linux-gnu
+      - name: Precompile
+        run: |
+          export ELIXIR_MAKE_CACHE_DIR=$(pwd)/cache
+          mkdir -p "${ELIXIR_MAKE_CACHE_DIR}"
+          mix deps.get
+          mix elixir_make.precompile
+      - uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          draft: true
+          files: |
+            cache/*.tar.gz
+            cache/*.sha256
+
+  macos:
+    runs-on: macos-13
+    env:
+      MIX_ENV: prod
+      ELIXIR_VERSION: "1.15.3"
+    strategy:
+      matrix:
+        otp_version: ["25.3"]
+    name: macOS x86_64 (${{ matrix.otp_version }})
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          curl -fsSO https://elixir-lang.org/install.sh
+          sh install.sh elixir@${{ env.ELIXIR_VERSION }} otp@${{ matrix.otp_version }}
+          otp_bin=($HOME/.elixir-install/installs/otp/*/bin)
+          elixir_bin=($HOME/.elixir-install/installs/elixir/*/bin)
+          echo "$otp_bin" >> "$GITHUB_PATH"
+          echo "$elixir_bin" >> "$GITHUB_PATH"
+      - name: Precompile
+        run: |
+          export ELIXIR_MAKE_CACHE_DIR=$(pwd)/cache
+          mkdir -p "${ELIXIR_MAKE_CACHE_DIR}"
+          mix deps.get
+          mix elixir_make.precompile
+      - uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          draft: true
+          files: |
+            cache/*.tar.gz
+            cache/*.sha256
+
+  windows:
+    runs-on: windows-2019
+    env:
+      MIX_ENV: prod
+      ELIXIR_VERSION: "1.15.3"
+    strategy:
+      matrix:
+        otp_version: ["25.3"]
+    name: Windows x86_64 (${{ matrix.otp_version }})
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp_version }}
+          elixir-version: ${{ env.ELIXIR_VERSION }}
+      - uses: ilammy/msvc-dev-cmd@v1
+      - name: Precompile
+        shell: bash
+        run: |
+          export ELIXIR_MAKE_CACHE_DIR=$(pwd)/cache
+          mkdir -p "${ELIXIR_MAKE_CACHE_DIR}"
+          mix deps.get
+          mix elixir_make.precompile
+      - uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          draft: true
+          files: |
+            cache/*.tar.gz
+            cache/*.sha256

.github/workflows/test.yml

@@ -1,12 +1,10 @@
 name: Test
-
 on:
   pull_request:
   push:
     branches:
       - main
       - "v*.*"
-
 jobs:
   linux:
     runs-on: ubuntu-20.04
@@ -28,7 +26,7 @@ jobs:
     env:
       MIX_ENV: test
       PYTHONX_TEST_PYTHON_MINOR: ${{ matrix.python_minor }}
-    name: Linux (3.${{ matrix.python_minor }}, ${{ matrix.pair.elixir }}, ${{ matrix.pair.otp }})
+    name: Linux x86_64 (3.${{ matrix.python_minor }}, ${{ matrix.pair.elixir }}, ${{ matrix.pair.otp }})
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
@@ -66,7 +64,7 @@ jobs:
     env:
       MIX_ENV: test
       PYTHONX_TEST_PYTHON_MINOR: ${{ matrix.python_minor }}
-    name: Windows (3.${{ matrix.python_minor }}, ${{ matrix.pair.elixir }}, ${{ matrix.pair.otp }})
+    name: Windows x86_64 (3.${{ matrix.python_minor }}, ${{ matrix.pair.elixir }}, ${{ matrix.pair.otp }})
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
@@ -99,7 +97,7 @@ jobs:
     env:
       MIX_ENV: test
       PYTHONX_TEST_PYTHON_MINOR: ${{ matrix.python_minor }}
-    name: macOS (3.${{ matrix.python_minor }}, ${{ matrix.pair.elixir }}, ${{ matrix.pair.otp }})
+    name: macOS x86_64 (3.${{ matrix.python_minor }}, ${{ matrix.pair.elixir }}, ${{ matrix.pair.otp }})
     steps:
       - uses: actions/checkout@v4
       - run: |

.gitignore

@@ -21,3 +21,6 @@ pythonx-*.tar
 
 # Temporary files, for example, from tests.
 /tmp/
+
+# Checksums for precompile binaries.
+/checksum.exs

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [v0.3.0](https://github.com/livebook-dev/pythonx/tree/v0.3.0) (Unreleased)
+
+Initial release.
+
+## Previous versions
+
+Prior to v0.3, this package was being published and developed in [this repository](https://github.com/elixir-pythonx/pythonx).

Makefile

@@ -30,4 +30,4 @@ build: $(NIF_PATH)
 
 $(NIF_PATH): $(SOURCES) $(HEADERS)
 	@ mkdir -p $(PRIV_DIR)
-	$(CC) $(CPPFLAGS) $(SOURCES) -o $(NIF_PATH)
+	$(CXX) $(CPPFLAGS) $(SOURCES) -o $(NIF_PATH)

README.md

@@ -166,6 +166,15 @@ For more details refer to the official documentation on
 
 <!-- Docs -->
 
+## Release
+
+1. Update version in `mix.exs` and update CHANGELOG.
+2. Run `git tag x.y.z` and `git push --tags`.
+   1. Wait for CI to precompile all artifacts.
+3. Run `mix elixir_make.checksum --all`.
+4. Run `mix hex.publish`.
+5. Bump version in `mix.exs` and add `-dev`.
+
 ## Acknowledgement
 
 Thank you to Cocoa Xu (@cocoa-xu) for building the first prototype of

c_src/pythonx/pythonx.cpp

@@ -205,12 +205,6 @@ void raise_if_failed(ErlNifEnv *env, const char *buffer) {
   }
 }
 
-void raise_if_failed(ErlNifEnv *env, int result) {
-  if (result == -1) {
-    raise_py_error(env);
-  }
-}
-
 void raise_if_failed(ErlNifEnv *env, Py_ssize_t size) {
   if (size == -1) {
     raise_py_error(env);

mix.exs

@@ -5,15 +5,27 @@ end
 defmodule Pythonx.MixProject do
   use Mix.Project
 
+  @version "0.3.0-dev"
+  @description "Python interpreter embedded in Elixir"
+  @github_url "https://github.com/livebook-dev/pythonx"
+
   def project do
     [
       app: :pythonx,
-      version: "0.3.0",
+      version: @version,
       elixir: "~> 1.15",
+      name: "Pythonx",
+      description: @description,
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       compilers: [:elixir_make] ++ Mix.compilers(),
-      docs: &docs/0
+      docs: docs(),
+      package: package(),
+      # Precompilation
+      make_precompiler: {:nif, CCPrecompiler},
+      make_precompiler_url: "#{@github_url}/releases/download/v#{@version}/@{artefact_filename}",
+      make_precompiler_filename: "libpythonx",
+      make_precompiler_nif_versions: [versions: ["2.16"]]
     ]
   end
 
@@ -27,11 +39,21 @@ defmodule Pythonx.MixProject do
   defp deps do
     [
       {:elixir_make, "~> 0.9", runtime: false},
+      {:cc_precompiler, "~> 0.1", runtime: false},
       {:ex_doc, "~> 0.36", only: :dev, runtime: false}
     ]
   end
 
   defp docs() do
     []
   end
+
+  defp package do
+    [
+      licenses: ["Apache-2.0"],
+      links: %{"GitHub" => @github_url},
+      files:
+        ~w(c_src lib mix.exs README.md LICENSE CHANGELOG.md Makefile Makefile.win checksum.exs)
+    ]
+  end
 end

mix.lock

@@ -1,4 +1,5 @@
 %{
+  "cc_precompiler": {:hex, :cc_precompiler, "0.1.10", "47c9c08d8869cf09b41da36538f62bc1abd3e19e41701c2cea2675b53c704258", [:mix], [{:elixir_make, "~> 0.7", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "f6e046254e53cd6b41c6bacd70ae728011aa82b2742a80d6e2214855c6e06b22"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.42", "f23d856f41919f17cd06a493923a722d87a2d684f143a1e663c04a2b93100682", [:mix], [], "hexpm", "6915b6ca369b5f7346636a2f41c6a6d78b5af419d61a611079189233358b8b8b"},
   "elixir_make": {:hex, :elixir_make, "0.9.0", "6484b3cd8c0cee58f09f05ecaf1a140a8c97670671a6a0e7ab4dc326c3109726", [:mix], [], "hexpm", "db23d4fd8b757462ad02f8aa73431a426fe6671c80b200d9710caf3d1dd0ffdb"},
   "ex_doc": {:hex, :ex_doc, "0.36.1", "4197d034f93e0b89ec79fac56e226107824adcce8d2dd0a26f5ed3a95efc36b1", [:mix], [{:earmark_parser, "~> 1.4.42", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "d7d26a7cf965dacadcd48f9fa7b5953d7d0cfa3b44fa7a65514427da44eafd89"},