folk-builder 0.1.1

Custom binary builder for Folk — generates and compiles a Folk server with selected plugins
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

name: Release

on:
  push:
    tags:
      - "v[0-9]+.[0-9]+.[0-9]+"

permissions:
  contents: write

env:
  CARGO_TERM_COLOR: always

jobs:
  build-linux:
    name: Build ${{ matrix.target }}
    runs-on: self-hosted

    strategy:
      matrix:
        include:
          - target: x86_64-unknown-linux-musl
            asset_name: folk-builder-linux-x86_64
          - target: aarch64-unknown-linux-musl
            asset_name: folk-builder-linux-aarch64

    steps:
      - uses: actions/checkout@v4
        with:
          clean: true

      - name: Clean target
        run: rm -rf /home/deploy/cargo-target target

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable

      - name: Build with cross
        run: cross build --release --target ${{ matrix.target }}
        env:
          CARGO_TARGET_DIR: target

      - name: Package
        run: |
          VERSION=${GITHUB_REF_NAME}
          ARCHIVE=${{ matrix.asset_name }}-${VERSION}.tar.gz
          tar -czf "${ARCHIVE}" -C target/${{ matrix.target }}/release folk-builder
          echo "ARCHIVE=${ARCHIVE}" >> $GITHUB_ENV

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.asset_name }}
          path: ${{ env.ARCHIVE }}

  build-macos:
    name: Build aarch64-apple-darwin
    runs-on: macos-latest

    steps:
      - uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: aarch64-apple-darwin

      - name: Build
        run: cargo build --release --target aarch64-apple-darwin

      - name: Package
        run: |
          VERSION=${GITHUB_REF_NAME}
          ARCHIVE=folk-builder-darwin-aarch64-${VERSION}.tar.gz
          tar -czf "${ARCHIVE}" -C target/aarch64-apple-darwin/release folk-builder
          echo "ARCHIVE=${ARCHIVE}" >> $GITHUB_ENV

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: folk-builder-darwin-aarch64
          path: ${{ env.ARCHIVE }}

  release:
    name: Create GitHub Release
    needs: [build-linux, build-macos]
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Download all artifacts
        uses: actions/download-artifact@v4
        with:
          path: dist/

      - name: Create release
        uses: softprops/action-gh-release@v2
        with:
          files: dist/**/*.tar.gz
          generate_release_notes: true
          body: |
            ## folk-builder ${{ github.ref_name }}

            Download for your platform and place in `$PATH`. Requires Rust 1.85+ installed on the build machine.

            ### Install

            **Linux x86_64:**
            ```bash
            curl -L https://github.com/Folk-Project/folk-builder/releases/download/${{ github.ref_name }}/folk-builder-linux-x86_64-${{ github.ref_name }}.tar.gz | tar xz
            sudo mv folk-builder /usr/local/bin/
            ```

            **Linux ARM64:**
            ```bash
            curl -L https://github.com/Folk-Project/folk-builder/releases/download/${{ github.ref_name }}/folk-builder-linux-aarch64-${{ github.ref_name }}.tar.gz | tar xz
            sudo mv folk-builder /usr/local/bin/
            ```

            **macOS (Apple Silicon):**
            ```bash
            curl -L https://github.com/Folk-Project/folk-builder/releases/download/${{ github.ref_name }}/folk-builder-darwin-aarch64-${{ github.ref_name }}.tar.gz | tar xz
            sudo mv folk-builder /usr/local/bin/
            ```

            ### Quick start

            Create `folk.build.toml` with all plugins:

            ```toml
            [build]
            output = "folk-server"

            [[plugin]]
            crate_name = "folk-plugin-http"
            version = "0.1"
            config_key = "http"

            [[plugin]]
            crate_name = "folk-plugin-metrics"
            version = "0.1"
            config_key = "metrics"

            [[plugin]]
            crate_name = "folk-plugin-process"
            version = "0.1"
            config_key = "process"

            [[plugin]]
            crate_name = "folk-plugin-jobs"
            version = "0.1"
            config_key = "jobs"

            [[plugin]]
            crate_name = "folk-plugin-grpc"
            version = "0.1"
            config_key = "grpc"
            ```

            Build and run:

            ```bash
            folk-builder build
            ./folk-server serve --config folk.toml
            ```

            See the [folk-builder README](https://github.com/Folk-Project/folk-builder) for full configuration reference.
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}