mirror of
https://github.com/tribufu/rust-gamedig
synced 2026-05-06 15:27:28 +00:00
* Add rich error type with source and backtrace
Adds a rich error type that will take a backtrace and allow capturing
the source of the error. The best way to use this is with the included
helpers that will automatically capture the backtrace and convert the
source error:
```
GDRichError::packet_bad_from_into("Reason packet was bad")
```
* [Crate] Bump MSRV to 1.65.0
This is required for backtraces in rich errors.
* Remove leftover debug logging
* [Errors] Replace variant overloads with single .rich method on kind enum
This overhaul replaces the exhaustive impls of each variant as multiple
methods on the rich error type with a singular .rich() method on the
kind enum. This consumes the variant and converts it to a rich error
with a source (.into() can be used if a source is not needed).
I also took the liberty of replacing all usages with the this new method
as I saw fit (adding various error messages) and converting a few
PacketBad errors to TypeParse errors when they are the result of parse
failing.
* Fix problem with rustdoc
* Remove BadGame's owned string
* Rename GDError to GDErrorKind
* Rename GDRichError to GDError
* Remove error impl from GDErrorKind
* Fix tests not passing
* Use error context everywhere map_err is used
* Improve GDError display formatter
* Add tests for new error type
116 lines
3.5 KiB
YAML
116 lines
3.5 KiB
YAML
# yaml-language-server: $schema=https://raw.githubusercontent.com/softprops/github-actions-schemas/master/workflow.json
|
|
name: CI
|
|
|
|
on:
|
|
push:
|
|
branches: [ "main" ]
|
|
pull_request:
|
|
branches: [ "main" ]
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
|
|
jobs:
|
|
build_first:
|
|
name: "Build, check, and test with all features"
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
shared-key: "cargo-deps"
|
|
cache-targets: false
|
|
- name: Run Build
|
|
run: cargo build --verbose --bins --lib --examples --all-features
|
|
- name: Run Tests
|
|
run: cargo test --verbose --bins --lib --examples --all-features
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
needs: [ "build_first" ]
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- build_type: ""
|
|
build_name: "Default"
|
|
- build_type: "--no-default-features"
|
|
build_name: "No features"
|
|
- build_type: "--no-default-features --features games"
|
|
build_name: "Just games"
|
|
- build_type: "--no-default-features --features services"
|
|
build_name: "Just Services"
|
|
- build_type: "--no-default-features --features game_defs"
|
|
build_name: "Just Game definitions"
|
|
- build_type: "--no-default-features --features serde"
|
|
build_name: "Just serde"
|
|
name: "Build ${{ matrix.build_name }}"
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
shared-key: "cargo-deps"
|
|
cache-targets: false
|
|
- name: Run Build
|
|
run: cargo build --verbose --bins --lib ${{ matrix.build_type }}
|
|
build_msrv:
|
|
name: "Build using MSRV"
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: Swatinem/rust-cache@v2
|
|
- name: Install MSRV
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
toolchain: 1.65.0
|
|
override: true
|
|
- name: Run MSRV
|
|
run: cargo build
|
|
formatting:
|
|
name: "Check code formatting"
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
cache-targets: false
|
|
- name: Install Formatting nightly
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
toolchain: nightly-2023-07-09
|
|
components: rustfmt
|
|
override: true
|
|
- name: Run Formatting check
|
|
run: cargo fmt --check --verbose
|
|
clippy:
|
|
name: "Run clippy tests"
|
|
runs-on: ubuntu-latest
|
|
needs: [ "build_first" ]
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
shared-key: "cargo-deps"
|
|
cache-targets: false
|
|
- name: Run Clippy
|
|
uses: actions-rs/clippy-check@v1
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
args: --bins --lib --examples --all-features
|
|
if: ${{ !env.ACT }} # skip during local actions testing
|
|
- name: Run clippy (local)
|
|
run: cargo clippy --verbose --bins --lib --examples --all-features
|
|
if: ${{ env.ACT }} # only run during local actions testing
|
|
doc:
|
|
name: "Check rustdoc"
|
|
runs-on: ubuntu-latest
|
|
needs: [ "build_first" ]
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
shared-key: "cargo-deps"
|
|
cache-targets: false
|
|
- name: "Run cargo doc"
|
|
run: cargo doc
|
|
env:
|
|
RUSTDOCFLAGS: "-D warnings"
|