beachcomber 0.4.0

A centralized daemon that caches shell state (git, battery, hostname, etc.) so every consumer reads from one fast cache instead of independently forking shells
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
name: Release

on:
  push:
    tags: ['v*']

permissions:
  contents: write

jobs:
  build:
    name: Build ${{ matrix.target }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - target: aarch64-apple-darwin
            os: macos-latest
          - target: x86_64-apple-darwin
            os: macos-latest
          - target: x86_64-unknown-linux-gnu
            os: ubuntu-latest
          - target: x86_64-unknown-linux-musl
            os: ubuntu-latest
            musl: true
          - target: aarch64-unknown-linux-gnu
            os: ubuntu-latest
            cross: true
    steps:
      - uses: actions/checkout@v4

      - name: Install musl tools
        if: matrix.musl
        run: sudo apt-get update && sudo apt-get install -y musl-tools

      - name: Install cross
        if: matrix.cross
        run: cargo install cross --version 0.2.5

      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}

      - uses: Swatinem/rust-cache@v2

      - name: Build (native)
        if: ${{ !matrix.cross }}
        run: cargo build --release --target ${{ matrix.target }}

      - name: Build (cross)
        if: matrix.cross
        run: cross build --release --target ${{ matrix.target }}

      - name: Package
        run: |
          cd target/${{ matrix.target }}/release
          tar czf ../../../beachcomber-${{ github.ref_name }}-${{ matrix.target }}.tar.gz comb
          cd ../../..

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: beachcomber-${{ matrix.target }}
          path: beachcomber-*.tar.gz

  c-sdk-tarball:
    name: Package C SDK
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Create C SDK tarball
        run: |
          tar czf beachcomber-c-sdk-${{ github.ref_name }}.tar.gz \
            -C sdks/c \
            beachcomber.c beachcomber.h json.c json.h Makefile libbeachcomber.pc.in README.md
      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: beachcomber-c-sdk
          path: beachcomber-c-sdk-*.tar.gz

  package-csdk:
    name: Package C SDK (${{ matrix.format }})
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - format: deb
          - format: rpm
    steps:
      - uses: actions/checkout@v4

      - name: Extract version
        id: version
        run: echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"

      - name: Build deb
        if: matrix.format == 'deb'
        run: bash packaging/deb-csdk/build.sh "${{ steps.version.outputs.version }}"

      - name: Build rpm
        if: matrix.format == 'rpm'
        run: |
          sudo apt-get update && sudo apt-get install -y rpm
          bash packaging/rpm-csdk/build.sh "${{ steps.version.outputs.version }}"

      - name: Upload package
        uses: actions/upload-artifact@v4
        with:
          name: libbeachcomber-${{ matrix.format }}
          path: |
            *.deb
            *.rpm

  test-csdk-packages:
    name: Test C SDK ${{ matrix.distro }} package
    needs: package-csdk
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - distro: ubuntu
            format: deb
            image: ubuntu:latest
          - distro: fedora
            format: rpm
            image: fedora:latest
    steps:
      - name: Download package
        uses: actions/download-artifact@v4
        with:
          name: libbeachcomber-${{ matrix.format }}
          path: pkg

      - name: Test install and pkg-config
        run: |
          docker run --rm -v ${{ github.workspace }}/pkg:/pkg ${{ matrix.image }} bash -c '
            if [ "${{ matrix.format }}" = "deb" ]; then
              apt-get update && apt-get install -y pkg-config
              dpkg -i /pkg/*.deb
            else
              dnf install -y pkg-config
              rpm -i /pkg/*.rpm
            fi
            pkg-config --exists libbeachcomber
            pkg-config --cflags libbeachcomber
            pkg-config --libs libbeachcomber
            test -f /usr/include/beachcomber.h
            test -f /usr/include/json.h
            test -f /usr/lib/libbeachcomber.so
            test -f /usr/lib/libbeachcomber.a
            echo "All checks passed"
          '

  package-linux:
    name: Package Linux (${{ matrix.format }}-${{ matrix.arch }})
    needs: build
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - format: deb
            arch: x86_64
            target: x86_64-unknown-linux-gnu
          - format: rpm
            arch: x86_64
            target: x86_64-unknown-linux-gnu
          - format: deb
            arch: aarch64
            target: aarch64-unknown-linux-gnu
          - format: rpm
            arch: aarch64
            target: aarch64-unknown-linux-gnu
    steps:
      - uses: actions/checkout@v4

      - uses: dtolnay/rust-toolchain@stable

      - name: Download binary artifact
        uses: actions/download-artifact@v4
        with:
          name: beachcomber-${{ matrix.target }}

      - name: Extract binary
        run: |
          mkdir -p target/${{ matrix.target }}/release
          tar xzf beachcomber-*.tar.gz -C target/${{ matrix.target }}/release

      - name: Build deb
        if: matrix.format == 'deb'
        run: |
          cargo install cargo-deb
          cargo deb --no-build --target ${{ matrix.target }}

      - name: Build rpm
        if: matrix.format == 'rpm'
        run: |
          cargo install cargo-generate-rpm
          cargo generate-rpm --target ${{ matrix.target }}

      - name: Upload package
        uses: actions/upload-artifact@v4
        with:
          name: beachcomber-${{ matrix.format }}-${{ matrix.arch }}
          path: |
            target/${{ matrix.target }}/debian/*.deb
            target/${{ matrix.target }}/generate-rpm/*.rpm

  test-packages:
    name: Test ${{ matrix.distro }} package
    needs: package-linux
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - distro: ubuntu
            format: deb
            image: ubuntu:latest
          - distro: fedora
            format: rpm
            image: fedora:latest
    steps:
      - name: Download package
        uses: actions/download-artifact@v4
        with:
          name: beachcomber-${{ matrix.format }}-x86_64
          path: pkg

      - name: Test install in container
        run: |
          docker run --rm -v ${{ github.workspace }}/pkg:/pkg ${{ matrix.image }} \
            bash -c 'pkg_file=$(find /pkg -name "*.${{ matrix.format }}" -type f); echo "Installing $pkg_file"; if [ "${{ matrix.format }}" = "deb" ]; then dpkg -i "$pkg_file"; else rpm -i "$pkg_file"; fi && comb --version'

  release:
    name: Create Release
    needs: [build, c-sdk-tarball, package-linux, test-packages, test-csdk-packages]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/download-artifact@v4
        with:
          merge-multiple: true
      - name: Create GitHub Release
        uses: softprops/action-gh-release@v2
        with:
          generate_release_notes: true
          files: |
            beachcomber-*.tar.gz
            *.deb
            *.rpm

  publish-crates:
    name: Publish to crates.io
    needs: release
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: rust-lang/crates-io-auth-action@v1
        id: crates-auth
      - name: Publish libbeachcomber
        run: cargo publish -p libbeachcomber || echo "Already published, skipping"
        env:
          CARGO_REGISTRY_TOKEN: ${{ steps.crates-auth.outputs.token }}
      - name: Publish beachcomber
        run: cargo publish -p beachcomber || echo "Already published, skipping"
        env:
          CARGO_REGISTRY_TOKEN: ${{ steps.crates-auth.outputs.token }}

  publish-pypi:
    name: Publish to PyPI
    needs: release
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    defaults:
      run:
        working-directory: sdks/python
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Build
        run: pip install build && python -m build
      - name: Publish
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          packages-dir: sdks/python/dist/
          skip-existing: true

  publish-npm:
    name: Publish to npm
    needs: release
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    defaults:
      run:
        working-directory: sdks/node
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '24'
          registry-url: 'https://registry.npmjs.org'
      - name: Install dependencies
        run: npm ci
      - name: Publish
        run: unset NODE_AUTH_TOKEN && npm publish --access public --provenance || echo "Already published, skipping"

  publish-rubygems:
    name: Publish to RubyGems
    needs: release
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    defaults:
      run:
        working-directory: sdks/ruby
    steps:
      - uses: actions/checkout@v4
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.3'
      - name: Build gem
        run: gem build libbeachcomber.gemspec
      - uses: rubygems/configure-rubygems-credentials@main
      - name: Publish
        run: gem push libbeachcomber-*.gem || echo "Already published, skipping"

  publish-luarocks:
    name: Publish to LuaRocks
    needs: release
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: sdks/lua
    steps:
      - uses: actions/checkout@v4
      - uses: leafo/gh-actions-lua@v10
        with:
          luaVersion: '5.4'
      - uses: leafo/gh-actions-luarocks@v4
      - name: Install JSON library
        run: luarocks install dkjson
      - name: Publish
        run: luarocks upload --skip-pack rockspec/libbeachcomber-0.4.0-1.rockspec --api-key=${{ secrets.LUAROCKS_API_KEY }} || echo "Already published, skipping"

  publish-go:
    name: Tag Go module
    needs: release
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Create Go module tag
        run: |
          git tag sdks/go/${{ github.ref_name }} || echo "Tag already exists, skipping"
          git push origin sdks/go/${{ github.ref_name }} || echo "Tag already pushed, skipping"

  publish-homebrew:
    name: Update Homebrew tap
    needs: release
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          repository: NavistAu/homebrew-tap
          token: ${{ secrets.HOMEBREW_TAP_TOKEN }}
          path: homebrew-tap

      - name: Download macOS artifacts
        uses: actions/download-artifact@v4
        with:
          pattern: beachcomber-*-apple-darwin
          merge-multiple: true
          path: artifacts

      - name: Generate formula
        run: |
          VERSION="${{ github.ref_name }}"
          VERSION="${VERSION#v}"
          ARM_SHA=$(shasum -a 256 artifacts/beachcomber-${{ github.ref_name }}-aarch64-apple-darwin.tar.gz | cut -d' ' -f1)
          INTEL_SHA=$(shasum -a 256 artifacts/beachcomber-${{ github.ref_name }}-x86_64-apple-darwin.tar.gz | cut -d' ' -f1)

          cat > homebrew-tap/Formula/beachcomber.rb << FORMULA
          class Beachcomber < Formula
            desc "Daemon that caches shell environment state for instant prompt rendering"
            homepage "https://github.com/NavistAu/beachcomber"
            version "${VERSION}"
            license "MIT"

            if Hardware::CPU.arm?
              url "https://github.com/NavistAu/beachcomber/releases/download/${{ github.ref_name }}/beachcomber-${{ github.ref_name }}-aarch64-apple-darwin.tar.gz"
              sha256 "${ARM_SHA}"
            else
              url "https://github.com/NavistAu/beachcomber/releases/download/${{ github.ref_name }}/beachcomber-${{ github.ref_name }}-x86_64-apple-darwin.tar.gz"
              sha256 "${INTEL_SHA}"
            end

            def install
              bin.install "comb"
            end

            test do
              assert_match "beachcomber", shell_output("#{bin}/comb --version")
            end
          end
          FORMULA

      - name: Push formula
        run: |
          cd homebrew-tap
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add Formula/beachcomber.rb
          git commit -m "beachcomber ${{ github.ref_name }}"
          git push

  publish-npm-binary:
    name: Publish beachcomber binary installer to npm
    needs: release
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    defaults:
      run:
        working-directory: placeholders/npm
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '24'
          registry-url: 'https://registry.npmjs.org'
      - name: Set version from tag
        run: npm version --no-git-tag-version --allow-same-version "${GITHUB_REF_NAME#v}"
      - name: Publish
        run: unset NODE_AUTH_TOKEN && npm publish --access public --provenance || echo "Already published, skipping"

  publish-pypi-binary:
    name: Publish beachcomber binary installer to PyPI
    needs: release
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    defaults:
      run:
        working-directory: placeholders/pypi
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Set version from tag
        run: sed -i "s/^version = .*/version = \"${GITHUB_REF_NAME#v}\"/" pyproject.toml
      - name: Build
        run: pip install build && python -m build
      - name: Publish
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          packages-dir: placeholders/pypi/dist/
          skip-existing: true