# dtolnay/rust-toolchain uses a curl argument (--retry-connrefused) that the curl shipped with our container doesn't support.

    # So we need to do one part ourselves; the action takes over the rest and prepares the setup further.

    - name: Prepare Rust toolchain

      run: |

        curl --proto '=https' --tlsv1.2 --retry 10 --location --silent --show-error --fail "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y

        echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH

    - name: Install Rust toolchain

      uses: dtolnay/rust-toolchain@stable

    - name: Enable Rust cache

      uses: Swatinem/rust-cache@v2

        echo "::group::Install breakpad dependencies"

        cargo install dump_syms

        echo "::endgroup::"

    - name: Create breakpad symbols

      run: |

        cd build

        dump_syms ./openttd --inlines --store symbols

    - name: Store symbols

      uses: actions/upload-artifact@v3

      with:

        name: symbols-linux-generic

        path: build/symbols

        retention-days: 5

    - name: Install Rust toolchain

      uses: dtolnay/rust-toolchain@stable

    - name: Enable Rust cache

      uses: Swatinem/rust-cache@v2

        echo "::group::Install brew dependencies"

        echo "::endgroup::"

        echo "::group::Install breakpad dependencies"

        cargo install dump_syms

        echo "::endgroup::"

    - name: Create breakpad symbols

      run: |

        cd build-x64

        mkdir dSYM

        dsymutil ./openttd -o dSYM/openttd

        dump_syms ./dSYM/openttd --inlines --store symbols

        cd ../build-arm64

        mkdir dSYM

        dsymutil ./openttd -o dSYM/openttd

        dump_syms ./dSYM/openttd --inlines --store ../build-x64/symbols

    - name: Store symbols

      uses: actions/upload-artifact@v3

      with:

        name: symbols-macos-universal

        path: build-x64/symbols

        retention-days: 5

    - name: Install Rust toolchain

      uses: dtolnay/rust-toolchain@stable

    - name: Enable Rust cache

      uses: Swatinem/rust-cache@v2

        echo "::group::Install choco dependencies"

        echo "::endgroup::"

        echo "::group::Install breakpad dependencies"

        cargo install dump_syms

        echo "::endgroup::"

    - name: Create breakpad symbols

      shell: bash

      run: |

        cd build

        dump_syms openttd.pdb --inlines --store symbols

        echo "::group::Move PDB and exe to symbols"

        PDB_FOLDER=$(find symbols -mindepth 2 -type d)

        cp openttd.pdb ${PDB_FOLDER}/

        EXE_FOLDER=symbols/openttd.exe/$(grep "INFO CODE_ID" symbols/*/*/openttd.sym | cut -d\  -f3)

        mkdir -p ${EXE_FOLDER}

        cp openttd.exe ${EXE_FOLDER}/

    - name: Store symbols

      uses: actions/upload-artifact@v3

      with:

        name: symbols-windows-${{ matrix.arch }}

        path: build/symbols

        retention-days: 5

    - name: Merge symbols

      run: |

        mkdir symbols

        cp -R symbols-*/* symbols/

        # Compress all files as gzip, to reduce cost of storage on the CDN.

        for i in $(find symbols -mindepth 2 -type f); do

          gzip ${i}

        done

        # Leave a mark in each folder what version actually created the symbol file.

        for i in $(find symbols -mindepth 2 -type d); do

          touch ${i}/.${{ inputs.version }}.txt

        done

    - name: Store breakpad symbols

      uses: actions/upload-artifact@v3

      with:

        name: cdn-symbols

        path: symbols/*

        retention-days: 5

  publish-bundles:

    name: Publish bundles

  publish-symbols:

    needs:

    - prepare

    name: Publish symbols

    uses: OpenTTD/actions/.github/workflows/rw-symbols-upload.yml@v4

    secrets:

      SYMBOLS_SIGNING_KEY: ${{ secrets.SYMBOLS_SIGNING_KEY }}

    with:

      artifact-name: cdn-symbols

      repository: OpenTTD

    - publish-bundles

# OpenTTD's Symbol Server

For all official releases, OpenTTD collects the Breakpad Symbols (SYM-files) and Microsoft's Symbols (PDB-files), and publishes them on our own Symbol Server (https://symbols.openttd.org).

These symbol files are needed to analyze `crash.dmp` files as attached to issues by users.

A `crash.dmp` is created on Windows, Linux, and MacOS when a crash happens.

This combined with the `crash.log` should give a pretty good indication what was going on at the moment the game crashed.

## Analyzing a crash.dmp

### MSVC

In MSVC you can add the above URL as Symbol Server (and please enable MSVC's for all other libraries), allowing you to analyze `crash.dmp`.

Now simply open up the `crash.dmp`, and start debugging.

### All other platforms

The best tool to use is `minidump-stackwalk` as published in the Rust's cargo index:

```bash

cargo install minidump-stackwalk

```

For how to install Rust, please see [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).

Now run the tool like:

```bash

minidump-stackwalk <crash.dmp> --symbols-url https://symbols.openttd.org

```

For convenience, the above Symbol Server also check with Mozilla's Symbol Server in case any other library but OpenTTD is requested.

This means files like `libc`, `kernel32.dll`, etc are all available on the above mentioned Symbol Server.