Merge #266

266: Make it work on windows 🎉 r=mergify[bot] a=thomaseizinger

Fixes #105. 

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
Co-authored-by: Daniel Karzel <daniel.karzel@coblox.tech>

Author: 3 people

.github/workflows/CI.yml

@@ -55,6 +55,13 @@ jobs:
           toolchain: ${{ env.RUST_TOOLCHAIN }}
           override: true
 
+      - name: Install OpenSSL and configure it to link statically
+        run: |
+          vcpkg install openssl:x64-windows-static
+          vcpkg integrate install
+          echo "::set-env name=RUSTFLAGS::-Ctarget-feature=+crt-static"
+        if: matrix.os == 'windows'
+
       - name: Build ${{ matrix.os }} binary
         run: make build
 
@@ -103,4 +110,4 @@ jobs:
           cd .npm
           yarn install
           yarn list
-          yarn test
+          yarn test

.github/workflows/release-bin.yml

@@ -7,46 +7,71 @@ on:
       - '[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
-  build:
-    name: Rust project
-    runs-on: ${{ matrix.os }}
+  rust_build:
     strategy:
       matrix:
-        os: [ubuntu-latest, macOS-latest]
+        os: [macos, windows, ubuntu]
+        include:
+          - os: windows
+            binary: create-comit-app.exe
+          - os: ubuntu
+            binary: create-comit-app
+          - os: macos
+            binary: create-comit-app
+    runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@master
-      # Workaround until actions/virtual-environments#6 is fixed
-      - name: Get Toolchain version
-        if: startsWith(matrix.os, 'macOS')
-        run: |
-          echo ::set-env name=TOOLCHAIN::$(cat rust-toolchain|head -n1)
-      - name: Install Rust
-        if: startsWith(matrix.os, 'macOS')
+      - name: Checkout sources
+        uses: actions/checkout@v1
+
+      - name: Extract toolchain version from rust-toolchain
+        run: echo "::set-env name=RUST_TOOLCHAIN::$(cat rust-toolchain)"
+
+      - name: Install ${{ env.RUST_TOOLCHAIN }} toolchain
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: ${{ env.TOOLCHAIN }}
-      - name: Build release
-        uses: actions-rs/cargo@v1
+          profile: minimal
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
+          override: true
+
+      - name: Install OpenSSL and configure it to link statically
+        run: |
+          vcpkg install openssl:x64-windows-static
+          vcpkg integrate install
+          echo "::set-env name=RUSTFLAGS::-Ctarget-feature=+crt-static"
+        if: matrix.os == 'windows'
+
+      - name: Build ${{ matrix.os }} release binary
+        run: make release
+
+      - name: Use Node.js 10.x
+        uses: actions/setup-node@v1
         with:
-          command: build
-          args: --release --all-features
+          node-version: 10.x
+
       - name: Create archive
         if: startsWith(github.ref, 'refs/tags/')
+        shell: bash
         run: |
-          VERSION=${GITHUB_REF##*/};
-          (cd ./target/release; tar czvf ~/create-comit-app_${VERSION}_$(uname -s)_$(uname -m).tar.gz create-comit-app;)
-          mv ~/create-comit-app_*.tar.gz .
-      - name: Upload asset
+          VERSION=$(git describe --tags)
+
+          # We need to do bash -c to make sure this also works on GitBash for Windows.
+          # GitHub actions uses GitBash for Windows if we say 'shell: bash' on a Windows executor.
+          ARCHIVE=$(bash -c "node .npm/printArchiveName.js ${VERSION}")
+
+          tar czvf ${ARCHIVE} -C target/release ${{ matrix.binary }}
+
+      - name: Upload asset to GitHub release
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: create-comit-app_*.tar.gz
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   npm_build:
     name: NPM Project
     runs-on: ubuntu-latest
-    needs: build # Do not publish if the build failed
+    needs: rust_build # Do not publish if the build failed
     steps:
       - uses: actions/checkout@v1
       - name: Use Node.js 10.x
@@ -66,4 +91,4 @@ jobs:
           cd .npm
           yarn publish
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.npm/download.js

@@ -1,30 +1,14 @@
 const fs = require("fs");
 const util = require("util");
-const exec = util.promisify(require("child_process").exec);
 const extract = util.promisify(require("targz").decompress);
 const axios = require("axios");
 const path = require("path");
-
-async function getSystem() {
-  const { stdout } = await exec("uname -s");
-  return stdout.trim();
-}
-
-async function getArch() {
-  const { stdout } = await exec("uname -m");
-  return stdout.trim();
-}
+const makeArchiveName = require("./makeArchiveName").default;
 
 async function download(version, binTarget) {
-  const system = await getSystem();
-  const arch = await getArch();
-  if (!version || !system || !arch) {
-    throw new Error("Could not retrieve needed information.");
-  }
-
   const targetDir = path.dirname(binTarget);
 
-  const archiveName = `create-comit-app_${version}_${system}_${arch}.tar.gz`;
+  const archiveName = makeArchiveName(version);
   const archivePath = targetDir + "/" + archiveName;
 
   if (!fs.existsSync(targetDir)) {

.npm/makeArchiveName.js

@@ -0,0 +1,8 @@
+const os = require("os");
+
+exports.default = function makeArchiveName(version) {
+  const kernel = os.type();
+  const arch = os.arch();
+
+  return `create-comit-app_${version}_${kernel}_${arch}.tar.gz`;
+};

.npm/printArchiveName.js

@@ -0,0 +1,12 @@
+const makeArchiveName = require("./makeArchiveName").default;
+
+const version = process.argv[2];
+
+if (!version) {
+  console.error("Please pass the version as the first argument.");
+  process.exit(1);
+}
+
+const archiveName = makeArchiveName(version);
+
+console.log(archiveName);

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## Added
+- Windows support :tada:.
+
 ## [0.5.2] - 2019-12-06
 
 ## Changed