spwhitton/git-remote-gcrypt

.editorconfig

@@ -0,0 +1,10 @@
+[[bash]]
+# For extension-less files (i.e., git-remote-gcrypt)
+indent_style=tab
+indent_size=4
+
+[*.sh]
+# For bash scripts with .sh extension
+indent_style=tab
+indent_size=4
+

.github/workflows/compatibility.yaml

@@ -0,0 +1,106 @@
+---
+name: compat
+
+on:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * 0" # Weekly on Sundays
+
+jobs:
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  # Validate 3 versions of git and GnuPG
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  git:
+    name: Git & GnuPG
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ matrix.image }}
+    strategy:
+      fail-fast: false
+      matrix:
+        image: [ubuntu:20.04, ubuntu:22.04, ubuntu:24.04]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies (container is root)
+        run: |
+          apt-get update
+          apt-get install -y curl gnupg make git python3-docutils rsync
+
+      - name: Tool versions (check)
+        run: |
+          gpg --version
+          git --version
+
+      - name: Run Tests
+        run: make test
+
+  # Ubuntu 20.04
+  # gpg (GnuPG) 2.2.19
+  # libgcrypt 1.8.5
+  # Home: /github/home/.gnupg
+  # Supported algorithms:
+  # Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA
+  # Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH,
+  #         CAMELLIA128, CAMELLIA192, CAMELLIA256
+  # Hash: SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
+  # Compression: Uncompressed, ZIP, ZLIB, BZIP2
+  # git version 2.25.1
+
+  # Ubuntu 22.04
+  # gpg (GnuPG) 2.2.27
+  # libgcrypt 1.9.4
+  # Home: /github/home/.gnupg
+  # Supported algorithms:
+  # Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA
+  # Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH,
+  #         CAMELLIA128, CAMELLIA192, CAMELLIA256
+  # Hash: SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
+  # Compression: Uncompressed, ZIP, ZLIB, BZIP2
+  # git version 2.34.1
+
+  # Ubuntu 24.04
+  # gpg (GnuPG) 2.4.4
+  # libgcrypt 1.10.3
+  # Home: /github/home/.gnupg
+  # Supported algorithms:
+  # Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA
+  # Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH,
+  #         CAMELLIA128, CAMELLIA192, CAMELLIA256
+  # Hash: SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
+  # Compression: Uncompressed, ZIP, ZLIB, BZIP2
+  # git version 2.43.0
+
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  # Validate completions for bash, zsh, and fish
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  shell-bash-zsh-fish:
+    name: Shell Completion Syntax
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Shells
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zsh fish
+
+      - name: Tool versions (check)
+        run: |
+          bash --version
+          zsh --version
+          fish --version
+
+      - name: Generate Completions (if not up to date)
+        run: make generate
+
+      - name: Check Bash Syntax
+        run: bash -n completions/bash/git-remote-gcrypt
+
+      - name: Check Zsh Syntax
+        run: zsh -n completions/zsh/_git-remote-gcrypt
+
+      - name: Check Fish Syntax
+        run: fish --no-execute completions/fish/git-remote-gcrypt.fish

.github/workflows/coverage.yaml

@@ -0,0 +1,60 @@
+---
+name: Coverage
+
+"on":
+  push:
+  schedule:
+    - cron: "0 0 * * 0" # Sunday at 12 AM
+
+jobs:
+  test-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Cache kcov
+        id: cache-kcov
+        uses: actions/cache@v4
+        with:
+          path: /usr/local/bin/kcov
+          key: ${{ runner.os }}-kcov-v1
+
+      # python3-docutils enables rst2man
+      - name: Install kcov Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y binutils-dev build-essential cmake git \
+          libssl-dev libcurl4-openssl-dev libelf-dev libdw-dev \
+          libiberty-dev zlib1g-dev libstdc++-12-dev \
+          python3-docutils
+
+      # Build & install kcov (on cache miss)
+      - name: Build and Install kcov
+        if: steps.cache-kcov.outputs.cache-hit != 'true'
+        run: |
+          git clone --branch v42 --depth 1 https://github.com/SimonKagstrom/kcov.git
+          cd kcov
+          mkdir build && cd build
+          cmake ..
+          make -j$(nproc)
+          sudo make install
+
+      - name: Check kcov installation
+        run: |
+          ls -l /usr/local/bin/kcov || echo "Kcov not found!"
+          kcov --version
+
+      - name: Test Installer [make test/installer]
+        run: make test/installer
+
+      - name: Test System [make test/system]
+        run: make test/system
+
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          # Path changed to match your Makefile's COV_ROOT (.coverage)
+          directory: ./.coverage

.github/workflows/install.yml

@@ -0,0 +1,114 @@
+---
+name: install
+
+on:
+  push:
+  workflow_dispatch:
+    inputs:
+      debug:
+        description: "Enable debug logging (GCRYPT_DEBUG=1)"
+        required: false
+        type: boolean
+        default: false
+  schedule:
+    - cron: "0 0 * * 0" # Sunday at 12 AM
+
+permissions:
+  contents: read
+
+jobs:
+  # Handles Ubuntu and macOS
+  Unix:
+    runs-on: ${{ matrix.os }}
+
+    env:
+      GCRYPT_DEBUG: ${{ inputs.debug && '1' || '' }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y git python3-docutils
+
+      - name: Dependencies (macOS)
+        if: runner.os == 'macOS'
+        run: brew install coreutils python3 git docutils
+
+      - name: Help [make]
+        run: make
+
+      - name: Test Installer
+        run: bash ./tests/installer-test-logic.sh
+
+      - name: Install [make install]
+        run: sudo make install
+
+      - name: Verify [make check/install]
+        run: make check/install
+
+  # Handles RedHat (UBI Container)
+  RedHat:
+    runs-on: ubuntu-latest
+
+    env:
+      GCRYPT_DEBUG: ${{ inputs.debug && '1' || '' }}
+
+    container:
+      image: registry.access.redhat.com/ubi9/ubi:latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # dnf is slow in containers. We cache the dnf cache directory.
+      - name: Cache DNF
+        uses: actions/cache@v4
+        with:
+          path: /var/cache/dnf
+          key: ${{ runner.os }}-ubi9-dnf-v1
+          restore-keys: |
+            ${{ runner.os }}-ubi9-dnf-
+
+      - name: Dependencies [redhat]
+        run: dnf install -y git python3-docutils make man-db
+
+      - name: Help [make]
+        run: make
+
+      - name: Test Installer
+        run: bash ./tests/installer-test-logic.sh
+
+      - name: Install [make install]
+        run: make install # container runs as sudo
+
+      - name: Verify [make check/install]
+        run: make check/install
+
+  # Handles Termux (Android shell)
+  termux-android:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Fix permissions for Docker
+        run: chmod -R 777 .
+
+      - name: Run tests in Termux
+        run: |
+          docker run --rm \
+            -v "$PWD":/app \
+            -w /app \
+            termux/termux-docker:latest \
+            /system/bin/sh -c "export PATH=/data/data/com.termux/files/usr/bin:\$PATH; \
+            apt-get update && \
+            apt-get install -y git make bash python man && \
+            pip install docutils && \
+            make install && \
+            make check/install && \
+            git-remote-gcrypt --version"

.github/workflows/lint.yaml

@@ -0,0 +1,41 @@
+---
+name: lint
+
+"on":
+  push:
+  workflow_dispatch:
+    inputs:
+      debug:
+        description: "Enable debug logging (GCRYPT_DEBUG=1)"
+        required: false
+        type: boolean
+        default: false
+  schedule:
+    - cron: "0 0 * * 0" # Sunday at 12 AM
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install ShellCheck
+        run: sudo apt-get update && sudo apt-get install -y shellcheck
+
+      - name: Lint [make lint]
+        run: make lint
+
+      - name: Check Formatting [make format]
+        # Requires shfmt and black.
+        # Assuming environment has them or we install them.
+        # ubuntu-latest has python3, we need shfmt.
+        run: |
+          sudo snap install shfmt
+          pip3 install black
+          make format
+          git diff --exit-code
+
+      - name: Check Generation [make generate]
+        run: |
+          make generate
+          git diff --exit-code

.gitignore

@@ -1,3 +1,8 @@
 /debian/files
 /debian/git-remote-gcrypt.substvars
 /debian/git-remote-gcrypt
+
+# Test coverage
+.coverage/
+# scratch pad
+.tmp/