add pre-release workflow, update readme install section for v1

pimalaya · Sep 19, 2024 · 4fd776f · 4fd776f
1 parent 891e114
commit 4fd776f
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 57 deletions.
diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml
@@ -0,0 +1,51 @@
+name: pre-release
+
+on:
+  push:
+
+jobs:
+  pre-release:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - target: x86_64-linux
+            os: ubuntu-latest
+          - target: aarch64-linux
+            os: ubuntu-latest
+          - target: x86_64-windows
+            os: ubuntu-latest
+          - target: x86_64-darwin
+            os: macos-13
+          - target: aarch64-darwin
+            os: macos-14
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install Nix
+        uses: cachix/install-nix-action@v27
+        with:
+          nix_path: nixpkgs=channel:nixos-24.05
+          enable_kvm: true
+          extra_nix_config: "experimental-features = nix-command flakes"
+      - name: Cache Nix store
+        uses: cachix/cachix-action@v15
+        with:
+          name: soywod
+          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+          extraPullNames: nix-community
+      - name: Build release
+        run: |
+          nix build -L .#${{ matrix.target }}
+          nix run -L .#${{ matrix.target }} -- --version
+      - name: Upload release artifact (tarball)
+        uses: actions/upload-artifact@v4
+        with:
+          name: "neverest.${{ matrix.target }}.tgz"
+          path: result/neverest.tgz
+      - name: Upload release artifact (zip)
+        uses: actions/upload-artifact@v4
+        with:
+          name: "neverest.${{ matrix.target }}.zip"
+          path: result/neverest.zip
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -36,23 +36,23 @@ jobs:
           - target: x86_64-windows
             os: ubuntu-latest
           - target: x86_64-darwin
-            os: macos-latest
-          # FIXME: build broken
-          # - target: aarch64-darwin
-          #   os: macos-latest
+            os: macos-13
+          - target: aarch64-darwin
+            os: macos-14
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2        
+        uses: actions/checkout@v4
       - name: Install Nix
-        uses: cachix/install-nix-action@v24
+        uses: cachix/install-nix-action@v27
         with:
-          nix_path: nixpkgs=channel:nixos-23.11
+          nix_path: nixpkgs=channel:nixos-24.05
           extra_nix_config: |
             experimental-features = nix-command flakes
-      - uses: cachix/cachix-action@v12
+      - uses: cachix/cachix-action@v15
         with:
           name: soywod
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+          extraPullNames: nix-community
       - name: Build release archive
         run: |
           nix build -L .#${{ matrix.target }}

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
diff --git a/README.md b/README.md
@@ -35,19 +35,41 @@
 
 ## Installation
 
-Neverest CLI can be installed with a prebuilt binary:
+*The `v1.0.0` is currently being tested on the `master` branch, and is the prefered version to use. Previous versions (including GitHub beta releases and repositories published versions) are not recommended.*
 
-```bash
-# As root:
-$ curl -sSL https://raw.githubusercontent.com/pimalaya/neverest/master/install.sh | sudo sh
+### Pre-built binary
+
+Neverest CLI `v1.0.0` can be installed with a pre-built binary. Find the latest [`pre-release`](https://github.com/pimalaya/neverest/actions/workflows/pre-release.yml) GitHub workflow and look for the *Artifacts* section. You should find a pre-built binary matching your OS.
+
+### Cargo (git)
+
+Neverest CLI `v1.0.0` can also be installed with [cargo](https://doc.rust-lang.org/cargo/):
 
-# As a regular user:
-$ curl -sSL https://raw.githubusercontent.com/pimalaya/neverest/master/install.sh | PREFIX=~/.local sh
+```bash
+$ cargo install --git https://github.com/pimalaya/neverest.git --force neverest
 ```
 
-These commands install the latest binary from the GitHub [releases](https://github.com/pimalaya/neverest/releases) section.
+### Other outdated methods
+
+These installation methods should not be used until the `v1.0.0` is finally released, as they are all (temporarily) outdated:
+
+<details>
+  <summary>Pre-built binary</summary>
 
-*Binaries are built with [default](https://github.com/pimalaya/neverest/blob/master/Cargo.toml#L18) cargo features. If you want to enable or disable a feature, please use another installation method.*
+  Neverest CLI can be installed with a prebuilt binary:
+
+  ```bash
+  # As root:
+  $ curl -sSL https://raw.githubusercontent.com/pimalaya/neverest/master/install.sh | sudo sh
+
+  # As a regular user:
+  $ curl -sSL https://raw.githubusercontent.com/pimalaya/neverest/master/install.sh | PREFIX=~/.local sh
+  ```
+
+  These commands install the latest binary from the GitHub [releases](https://github.com/pimalaya/neverest/releases) section.
+
+  *Binaries are built with [default](https://github.com/pimalaya/neverest/blob/master/Cargo.toml#L18) cargo features. If you want to enable or disable a feature, please use another installation method.*
+</details>
 
 <details>
   <summary>Cargo</summary>