Skip to content

Commit

Permalink
temporary checkin for publishing warning
Browse files Browse the repository at this point in the history
- introduced issue templates for filing issues
  - no one is really using these yet, but for the future, when
    folks do want to file issues hopefully this cleans up a lot more.
- introduce better (and actual!) version output to `bridgectl`
  - turns out "version" command is handled as an error which is so weird
  - anyway we now properly print out a version.
- add load bearing sleep to PCFS SATA
  - PCFS Sata suffers the same TCP buffer bug as SDIO.
- pre-emptively update package version
- introduce `ATAPI` client to eventually use for "scientists"
  - scientists being implemented in later commits to this PR, will be
    a way of effectively "proxying" a call to a real Cafe SDK setup,
    and logging when bytes differ between it and us.
  - Also we should just have a client interface anyway for the future.
- Make `cat-dev` library actually have "features"
  - this introduces quite a few non functional changes where folks can
    now enable/disable features from `cat-dev` to only compile certain
    bits of code & include it.
  - rather than having to include supports for all clients, and servers,
    and serial code for every project wanting to talk to anything
    cat-dev related at all. You can now start including "big areas"
    e.g. "clients", "servers", "serial", etc.
  • Loading branch information
Mythra committed Feb 7, 2025
1 parent fa1ebdc commit 6fd754b
Show file tree
Hide file tree
Showing 65 changed files with 3,489 additions and 1,912 deletions.
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
name: Bug Report with Built/Installed Tools
description: File a bug report about issues using already built/installed tools
title: "[Tool Bug]: "
labels: ["bug", "triage"]
projects: []
assignees:
- mythra
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please also set the environment variable `SPRIG_LOGGING=info,bridgectl=debug,cat_dev=debug`
for the most helpful information in logs. This will produce a lot of logging information that's
very helpful for us!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of our software are you running (`bridgectl --version`)?
validations:
required: true
- type: dropdown
id: host-os
attributes:
label: What host-os are you running on?
multiple: true
options:
- Windows
- macOS
- Linux (any flavour)
- BSD (any flavour)
- Other Nix Based System
- Other Non Nix, or non BSD based OS
- type: input
id: target
attributes:
label: Target Device
description: If talking to a device (e.g. a cat-dev/cat-r) please list the device + it's version here.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rem-verse/sprig/blob/trunk/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/installer-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: Installing/Building Sprig Bug Report
description: File a bug report about issues installing, or building Sprig
title: "[Installer Bug]: "
labels: ["bug", "triage"]
projects: []
assignees:
- mythra
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of our software are you attempting to install/build?
validations:
required: true
- type: dropdown
id: host-os
attributes:
label: What host-os are you attempting to build/install on?
multiple: true
options:
- Windows
- macOS
- Linux (any flavour)
- BSD (any flavour)
- Other Nix Based System
- Other Non Nix, or non BSD based OS
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rem-verse/sprig/blob/trunk/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/library-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
name: Bug Report with Development Library
description: File a bug report about any of the libraries we publish for others to use
title: "[Library Bug]: "
labels: ["bug", "triage"]
projects: []
assignees:
- mythra
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-is-the-issue
attributes:
label: What is the issue?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "Your library is doing something wrong!"
validations:
required: true
- type: input
id: package
attributes:
label: Package
description: What package are you running into an issue with?
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of the package did you experience the bug in?
validations:
required: true
- type: input
id: features
attributes:
label: Features
description: If using a library, what features have you enabled/disabled if you are not using the default?
validations:
required: false
- type: dropdown
id: host-os
attributes:
label: What host-os are you using?
multiple: true
options:
- Windows
- macOS
- Linux (any flavour)
- BSD (any flavour)
- Other Nix Based System
- Other Non Nix, or non BSD based OS
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rem-verse/sprig/blob/trunk/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
58 changes: 58 additions & 0 deletions .github/workflows/feature-matrixes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Validate Feature Matrix Merge

on:
pull_request:
branches:
- trunk

jobs:
check:
name: Check Compilation of All Feature Combinations
strategy:
matrix:
os: [ubuntu-22.04, windows-2022, macos-14]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Install Rust
run: rustup update stable
- name: Run Check
run: cargo hack check --feature-powerset
test:
name: Run Non Doc Tests on All Feature Combinations
strategy:
matrix:
os: [ubuntu-22.04, windows-2022, macos-14]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack,cargo-nextest
- name: Install Rust
run: rustup update stable
- name: Run Nextest
run: cargo hack nextest run --feature-powerset --no-tests=pass
env:
RUST_BACKTRACE: full
doc-test:
name: Run Doc Tests on All Feature Combinations
strategy:
matrix:
os: [ubuntu-22.04, windows-2022, macos-14]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Install Rust
run: rustup update stable
- name: Run Doc Tests (cat-dev)
run: cargo hack test --doc --feature-powerset --manifest-path "pkg/cat-dev/Cargo.toml"
env:
RUST_BACKTRACE: full
10 changes: 5 additions & 5 deletions .github/workflows/package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
!target/release/deps
!target/release/examples
!target/release/incremental
package-osx-arn:
package-osx-arm:
name: Package Mac OS X systems (ARM)
runs-on: macos-14
steps:
Expand Down Expand Up @@ -128,19 +128,19 @@ jobs:
- uses: actions/upload-artifact@v4
with:
name: sprig_unix_amd64.deb
path: installer-scripts/unix/sprig_0.0.8_amd64.deb
path: installer-scripts/unix/sprig_0.0.9_amd64.deb
- uses: actions/upload-artifact@v4
with:
name: sprig_unix_amd64.rpm
path: installer-scripts/unix/sprig-0.0.8-1.x86_64.rpm
path: installer-scripts/unix/sprig-0.0.9-1.x86_64.rpm
- uses: actions/upload-artifact@v4
with:
name: sprig_unix_amd64.apk
path: installer-scripts/unix/sprig_0.0.8_x86_64.apk
path: installer-scripts/unix/sprig_0.0.9_x86_64.apk
- uses: actions/upload-artifact@v4
with:
name: sprig_unix_amd64.pkg.tar.zst
path: installer-scripts/unix/sprig-0.0.8-1-x86_64.pkg.tar.zst
path: installer-scripts/unix/sprig-0.0.9-1-x86_64.pkg.tar.zst
- uses: actions/upload-artifact@v4
with:
name: sprig-target-directory-unix
Expand Down
12 changes: 7 additions & 5 deletions .github/workflows/validate-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
- name: Run format check
run: cargo fmt --all --check
- name: Validate clippy
run: cargo clippy -- -W clippy::pedantic -D warnings
run: cargo clippy --no-default-features --all-features -- -W clippy::pedantic -D warnings
build:
name: Build
strategy:
Expand All @@ -57,7 +57,7 @@ jobs:
- name: Install Rust
run: rustup update stable
- name: Run Build
run: cargo build --all
run: cargo build --all --all-features
test:
name: Run non doc tests
strategy:
Expand All @@ -66,11 +66,13 @@ jobs:
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: taiki-e/install-action@nextest
- uses: taiki-e/install-action@v2
with:
tool: cargo-nextest
- name: Install Rust
run: rustup update stable
- name: Run Nextest
run: cargo nextest run
run: cargo nextest run --all-features
env:
RUST_BACKTRACE: full
doc-test:
Expand All @@ -84,6 +86,6 @@ jobs:
- name: Install Rust
run: rustup update stable
- name: Run Doc Tests
run: cargo test --doc
run: cargo test --doc --all-features
env:
RUST_BACKTRACE: full
Loading

0 comments on commit 6fd754b

Please sign in to comment.