suricate 0.1.1

A gedcom viewer
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

name: Build

# from https://github.com/sharkdp/fd

env:
    CICD_INTERMEDIATES_DIR: "_cicd-intermediates"
    MSRV_FEATURES: "--all-features"

on:
    workflow_dispatch:
    push:
        tags:
            - "*"

permissions:
    contents: write

jobs:
    crate_metadata:
        name: Extract crate metadata
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v6
            - name: Extract crate information
              id: crate_metadata
              run: |
                  cargo metadata --no-deps --format-version 1 | jq -r '"name=" + .packages[0].name' | tee -a $GITHUB_OUTPUT
                  cargo metadata --no-deps --format-version 1 | jq -r '"version=" + .packages[0].version' | tee -a $GITHUB_OUTPUT
                  cargo metadata --no-deps --format-version 1 | jq -r '"maintainer=" + .packages[0].authors[0]' | tee -a $GITHUB_OUTPUT
                  cargo metadata --no-deps --format-version 1 | jq -r '"homepage=" + .packages[0].homepage' | tee -a $GITHUB_OUTPUT
                  cargo metadata --no-deps --format-version 1 | jq -r '"msrv=" + .packages[0].rust_version' | tee -a $GITHUB_OUTPUT
        outputs:
            name: ${{ steps.crate_metadata.outputs.name }}
            version: ${{ steps.crate_metadata.outputs.version }}
            maintainer: ${{ steps.crate_metadata.outputs.maintainer }}
            homepage: ${{ steps.crate_metadata.outputs.homepage }}
            msrv: ${{ steps.crate_metadata.outputs.msrv }}

    ensure_cargo_fmt:
        name: Ensure 'cargo fmt' has been run
        runs-on: ubuntu-latest
        steps:
            - uses: dtolnay/rust-toolchain@stable
              with:
                  components: rustfmt
            - uses: actions/checkout@v6
            - run: cargo fmt -- --check

    lint_check:
        name: Ensure 'cargo clippy' has no warnings
        runs-on: ubuntu-latest
        steps:
            - uses: dtolnay/rust-toolchain@stable
              with:
                  components: clippy
            - uses: actions/checkout@v6
            - run: cargo clippy --all-targets --all-features -- -D warnings

    # min_version:
    #     name: Minimum supported rust version
    #     runs-on: ubuntu-latest
    #     needs: crate_metadata
    #     steps:
    #         - name: Checkout source code
    #           uses: actions/checkout@v6

    #         - name: Install rust toolchain (v${{ needs.crate_metadata.outputs.msrv }})
    #           uses: dtolnay/rust-toolchain@master
    #           with:
    #               toolchain: ${{ needs.crate_metadata.outputs.msrv }}
    #               components: clippy
    #         - name: Run clippy (on minimum supported rust version to prevent warnings we can't fix)
    #           run: cargo clippy --locked --all-targets ${{ env.MSRV_FEATURES }}
    #         - name: Run tests
    #           run: cargo test --locked ${{ env.MSRV_FEATURES }}

    build:
        name: ${{ matrix.job.target }} (${{ matrix.job.os }})
        if: contains(join(github.event.commits.*.modified, ' '), 'Cargo.toml') || contains(join(github.event.commits.*.added, ' '), 'Cargo.toml')
        runs-on: ${{ matrix.job.os }}
        needs: crate_metadata
        strategy:
            fail-fast: false
            matrix:
                job:
                    - { target: aarch64-unknown-linux-gnu, os: ubuntu-24.04, use-cross: true }
                    - { target: aarch64-unknown-linux-musl, os: ubuntu-24.04, use-cross: true }
                    - { target: arm-unknown-linux-gnueabihf, os: ubuntu-24.04, use-cross: true }
                    - { target: arm-unknown-linux-musleabihf, os: ubuntu-24.04, use-cross: true }
                    - { target: i686-unknown-linux-gnu, os: ubuntu-24.04, use-cross: true }
                    - { target: i686-unknown-linux-musl, os: ubuntu-24.04, use-cross: true }
                    - { target: x86_64-unknown-linux-gnu, os: ubuntu-24.04, use-cross: true }
                    - { target: x86_64-unknown-linux-musl, os: ubuntu-24.04, use-cross: true }
                    - { target: x86_64-apple-darwin, os: macos-15-intel }
                    - { target: aarch64-apple-darwin, os: macos-latest }
                    - { target: i686-pc-windows-msvc, os: windows-2022 }
                    - { target: x86_64-pc-windows-gnu, os: windows-2022 }
                    - { target: x86_64-pc-windows-msvc, os: windows-2022 }
        env:
            BUILD_CMD: cargo
        steps:
            - name: Checkout source code
              uses: actions/checkout@v6

            - name: Install prerequisites
              shell: bash
              run: |
                  case ${{ matrix.job.target }} in
                    arm-unknown-linux-*) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;;
                    aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install gcc-aarch64-linux-gnu ;;
                  esac

            - name: Install Rust toolchain
              uses: dtolnay/rust-toolchain@stable
              with:
                  targets: ${{ matrix.job.target }}
                  # On windows, for now build with correct version, so that it works on windows 7.
                  # When we update the MSRV again, we'll need to revisit this, and probably drop support for Win7
                  toolchain: "${{ contains(matrix.job.target, 'windows-') && '1.94' || 'stable' }}"

            - name: Install cross
              if: matrix.job.use-cross
              uses: taiki-e/install-action@v2
              with:
                  tool: cross

            - name: Overwrite build command env variable
              if: matrix.job.use-cross
              shell: bash
              run: echo "BUILD_CMD=cross" >> $GITHUB_ENV

            - name: Show version information (Rust, cargo, GCC)
              shell: bash
              run: |
                  gcc --version || true
                  rustup -V
                  rustup toolchain list
                  rustup default
                  rustup target add ${{ matrix.job.target }}
                  cargo -V
                  rustc -V

            - name: Build
              shell: bash
              run: $BUILD_CMD build --locked --release --target=${{ matrix.job.target }}

            - name: Set binary name & path
              id: bin
              shell: bash
              run: |
                  # Figure out suffix of binary
                  EXE_suffix=""
                  case ${{ matrix.job.target }} in
                    *-pc-windows-*) EXE_suffix=".exe" ;;
                  esac;

                  # Setup paths
                  BIN_NAME="${{ needs.crate_metadata.outputs.name }}${EXE_suffix}"
                  BIN_PATH="target/${{ matrix.job.target }}/release/${BIN_NAME}"

                  # Let subsequent steps know where to find the binary
                  echo "BIN_PATH=${BIN_PATH}" >> $GITHUB_OUTPUT
                  echo "BIN_NAME=${BIN_NAME}" >> $GITHUB_OUTPUT

            # - name: Set testing options
            #   id: test-options
            #   shell: bash
            #   run: |
            #       # test only library unit tests and binary for arm-type targets
            #       unset CARGO_TEST_OPTIONS
            #       unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--bin ${{ needs.crate_metadata.outputs.name }}" ;; esac;
            #       echo "CARGO_TEST_OPTIONS=${CARGO_TEST_OPTIONS}" >> $GITHUB_OUTPUT

            # - name: Run tests
            #   shell: bash
            #   run: $BUILD_CMD test --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}}

            # - name: Generate completions
            #   id: completions
            #   shell: bash
            #   run: make completions

            - name: Create tarball
              id: package
              shell: bash
              run: |
                  PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
                  PKG_BASENAME=${{ needs.crate_metadata.outputs.name }}-v${{ needs.crate_metadata.outputs.version }}-${{ matrix.job.target }}
                  PKG_NAME=${PKG_BASENAME}${PKG_suffix}
                  echo "PKG_NAME=${PKG_NAME}" >> $GITHUB_OUTPUT

                  PKG_STAGING="${{ env.CICD_INTERMEDIATES_DIR }}/package"
                  ARCHIVE_DIR="${PKG_STAGING}/${PKG_BASENAME}/"
                  mkdir -p "${ARCHIVE_DIR}"

                  # Binary
                  cp "${{ steps.bin.outputs.BIN_PATH }}" "$ARCHIVE_DIR"

                  # README, LICENSE and CHANGELOG files
                  cp "README.md" "LICENSE" "CHANGELOG.md" "$ARCHIVE_DIR"

                  # Man page
                  #cp 'doc/${{ needs.crate_metadata.outputs.name }}.1' "$ARCHIVE_DIR"

                  # Autocompletion files
                  #cp -r autocomplete "${ARCHIVE_DIR}"

                  # base compressed package
                  pushd "${PKG_STAGING}/" >/dev/null
                  case ${{ matrix.job.target }} in
                    *-pc-windows-*) 7z -y a "${PKG_NAME}" "${PKG_BASENAME}"/* | tail -2 ;;
                    *) tar czf "${PKG_NAME}" "${PKG_BASENAME}"/* ;;
                  esac;
                  popd >/dev/null

                  # Let subsequent steps know where to find the compressed package
                  echo "PKG_PATH=${PKG_STAGING}/${PKG_NAME}" >> $GITHUB_OUTPUT

            # - name: Create Debian package
            #   id: debian-package
            #   shell: bash
            #   if: startsWith(matrix.job.os, 'ubuntu')
            #   run: bash scripts/create-deb.sh
            #   env:
            #       TARGET: ${{ matrix.job.target }}
            #       DPKG_VERSION: ${{ needs.crate_metadata.version }}
            #       BIN_PATH: ${{ steps.bin.outputs.BIN_PATH }}

            - name: "Artifact upload: tarball"
              uses: actions/upload-artifact@main
              with:
                  name: ${{ steps.package.outputs.PKG_NAME }}
                  path: ${{ steps.package.outputs.PKG_PATH }}

            # - name: "Artifact upload: Debian package"
            #   uses: actions/upload-artifact@main
            #   if: steps.debian-package.outputs.DPKG_NAME
            #   with:
            #       name: ${{ steps.debian-package.outputs.DPKG_NAME }}
            #       path: ${{ steps.debian-package.outputs.DPKG_PATH }}

            - name: Publish archives and packages
              uses: softprops/action-gh-release@v2
              with:
                  files: |
                      ${{ steps.package.outputs.PKG_PATH }}