Distribute standalone binaries (#1)

Author: mondeja

.github/workflows/ci.yml

@@ -48,8 +48,16 @@ jobs:
           command: pre-commit run --all-files --show-diff-on-failure
 
   build:
-    name: Build
-    runs-on: ubuntu-latest
+    name: Build hledger-fmt
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on:
+          - ubuntu-latest
+          - macos-14 # ARM
+          - macos-13 # X86
+          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - name: Setup Rust
@@ -59,6 +67,61 @@ jobs:
           profile: minimal
       - name: Build
         run: cargo build --release
+      - name: Standarize Windows executable path
+        if: matrix.runs-on == 'windows-latest'
+        run: mv target/release/hledger-fmt.exe target/release/hledger-fmt
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.runs-on }}-build
+          path: ./target/release/hledger-fmt
+          if-no-files-found: error
+          overwrite: true
+
+  dist:
+    name: Create distribution packages
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Create directories
+        run: mkdir -p dist build/mac build/linux build/windows
+      - name: Download MacOS ARM artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: macos-14-build
+          path: ./build/mac-arm64
+      - name: Download MacOS X86 artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: macos-13-build
+          path: ./build/mac-x64
+      - name: Download Linux artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ubuntu-latest-build
+          path: ./build/linux
+      - name: Download Windows artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: windows-latest-build
+          path: ./build/windows
+      - name: Create Linux tarball
+        run: tar -czf dist/hledger-fmt-linux-x64.tar.gz -C build/linux hledger-fmt
+      - name: Create MacOS tarballs
+        run: |
+          tar -czf dist/hledger-fmt-mac-x64.tar.gz -C build/mac-x64 hledger-fmt
+          tar -czf dist/hledger-fmt-mac-arm64.tar.gz -C build/mac-arm64 hledger-fmt
+      - name: Create Windows zip
+        run: |
+          cd build/windows
+          mv hledger-fmt hledger-fmt.exe
+          7z a -tzip ../../dist/hledger-fmt-windows-x64.zip hledger-fmt.exe
+      - name: Remove build directories
+        run: rm -rf build
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: ./dist
 
   unit-tests:
     name: Unit tests
@@ -92,7 +155,7 @@ jobs:
     needs:
       - qa
       - unit-tests
-      - build
+      - dist
     if: |
       '${{ github.event.pull_request.user.login }}' == 'mondeja' ||
       startsWith(github.ref, 'refs/tags/') ||
@@ -114,8 +177,7 @@ jobs:
   release:
     if: startsWith(github.ref, 'refs/tags/')
     name: Release heldger-fmt
-    needs:
-      - test-release
+    needs: test-release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -132,8 +194,7 @@ jobs:
   create-release:
     if: startsWith(github.ref, 'refs/tags/')
     name: Create release
-    needs:
-      - release
+    needs: release
     permissions:
       contents: write
     runs-on: ubuntu-latest
@@ -144,6 +205,11 @@ jobs:
         run: |
           TAG_TITLE=${GITHUB_REF#refs/*/}
           echo "title=$TAG_TITLE" >> $GITHUB_OUTPUT
+      - name: Download distribution
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: ./dist
       - name: Create release
         uses: softprops/action-gh-release@v2
         env:
@@ -155,3 +221,8 @@ jobs:
             See [CHANGELOG](https://github.com/mondeja/hledger-fmt/blob/master/CHANGELOG.md).
           draft: false
           prerelease: false
+          files: |
+            ./dist/hledger-fmt-linux-x64.tar.gz
+            ./dist/hledger-fmt-mac-x64.tar.gz
+            ./dist/hledger-fmt-mac-arm64.tar.gz
+            ./dist/hledger-fmt-windows-x64.zip

.gitignore

@@ -1,2 +1,3 @@
 /target
 .prettier-cache
+/dist/

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 2024-09-28 - [0.1.3]
+
+### Enhancements
+
+- Provide standalone binaries for Windows X86_64 and Linux X86_64,
+  MacOS X86_64 and MacOS ARM64.
+
 ## 2024-09-27 - [0.1.2]
 
 ### Bug fixes
@@ -16,5 +23,6 @@
 
 First beta release
 
+[0.1.3]: https://github.com/mondeja/hledger-fmt/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/mondeja/hledger-fmt/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/mondeja/hledger-fmt/compare/v0.1.0...v0.1.1

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "hledger-fmt"
-version = "0.1.2"
+version = "0.1.3"
 edition = "2021"
 description = "An opinionated hledger's journal files formatter."
 repository = "https://github.com/mondeja/hledger-fmt"
@@ -25,14 +25,14 @@ path = "src/lib.rs"
 name = "hledger-fmt"
 
 [dependencies]
-clap = { version = "4", features = ["derive"] }
+clap = { version = "4", default-features = false, features = ["std", "help", "derive"] }
 walkdir = "2"
 similar = "2"
 colored = { version = "2", optional = true }
 
 [features]
 default = ["color"]
-color = ["dep:colored"]
+color = ["dep:colored", "clap/color"]
 
 [workspace]
 members = ["."]

Cargo.toml

@@ -3,7 +3,6 @@
 [![Crates.io](https://img.shields.io/crates/v/hledger-fmt?logo=rust)](https://crates.io/crates/hledger-fmt)
 [![License](https://img.shields.io/crates/l/hledger-fmt)][license-badge-link]
 [![Tests](https://img.shields.io/github/actions/workflow/status/mondeja/hledger-fmt/ci.yml?label=tests&logo=github)][tests-badge-link]
-[![Crates.io downloads](https://img.shields.io/crates/d/hledger-fmt)](https://crates.io/crates/hledger-fmt)
 
 <!-- markdown-link-check-disable -->
 
@@ -16,19 +15,28 @@ An opinionated [hledger]'s journal files formatter.
 
 ## Installation
 
-Build from source using [cargo]:
+[![Crates.io downloads](https://img.shields.io/crates/d/hledger-fmt?label=Crate%20downloads)](https://crates.io/crates/hledger-fmt)
+![GitHub downloads](https://img.shields.io/github/downloads/mondeja/hledger-fmt/total?label=GitHub%20downloads)
 
-```bash
-cargo install hledger-fmt
-```
+### Standalone pre-built binaries
+
+Download standalone pre-built binaries from [releases page].
+
+### Cargo binaries
 
 Install from pre-built binaries using [cargo-binstall]:
 
-```bash
+```sh
 cargo binstall hledger-fmt
 ```
 
-We don't currently provide standalone pre-built binaries.
+### Build from source
+
+Build from source using [cargo]:
+
+```sh
+cargo install hledger-fmt
+```
 
 ### pre-commit
 
@@ -49,7 +57,7 @@ When you don't pass files to format, it reads all the files with
 the extensions `.journal`, `.hledger` and `.j` in the current directory
 and its subdirectories.
 
-```bash
+```sh
 hledger-fmt [OPTIONS] [FILES]...
 ```
 
@@ -59,7 +67,7 @@ To fix them in place, use the `--fix` option:
 > This is a potentially destructive operation. Make sure to make a backup
 > of your files before running this command for the first time.
 
-```bash
+```sh
 hledger-fmt --fix [FILES]...
 ```
 
@@ -72,4 +80,5 @@ See `hledger-fmt --help` for more information.
 [cargo-binstall]: https://github.com/cargo-bins/cargo-binstall
 [hledger]: https://hledger.org
 [cargo]: https://doc.rust-lang.org/cargo/
+[releases page]: https://github.com/mondeja/hledger-fmt/releases
 [pre-commit]: https://pre-commit.com