unyt-org · github-actions · Oct 26, 2025 · Oct 29, 2025 · Oct 29, 2025 · Oct 16, 2025
diff --git a/.github/workflows/base_benchmarks.yml b/.github/workflows/base_benchmarks.yml
@@ -12,7 +12,7 @@ jobs:
             cancel-in-progress: true
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v4
+            - uses: actions/checkout@v5
             - name: Cache dependencies
               uses: actions/cache@v4
               env:

diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -21,7 +21,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v5
 
             - name: Set up Deno
               uses: denoland/setup-deno@v2

diff --git a/.github/workflows/pr_benchmarks.yml b/.github/workflows/pr_benchmarks.yml
@@ -13,7 +13,7 @@ jobs:
             pull-requests: write
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v4
+            - uses: actions/checkout@v5
             - name: Cache dependencies
               uses: actions/cache@v4
               env:

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -6,7 +6,7 @@ jobs:
         runs-on: ubuntu-latest
         name: Publish
         steps:
-            - uses: actions/checkout@v4
+            - uses: actions/checkout@v5
 
             - name: Install libudev-dev and pkg-config
               run: |

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,7 +7,7 @@ jobs:
         runs-on: ubuntu-latest
         name: Release
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v5
 
             - name: Extract version from Cargo.toml
               id: get_version

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,13 +6,13 @@ jobs:
         runs-on: ubuntu-latest
         name: Test
         concurrency:
-            group: ${{ github.workflow }}-${{ github.ref }}
+            group: ${{ github.workflow }}-${{ github.ref }}-test
             cancel-in-progress: true
         env:
             PROJECT_NAME_UNDERSCORE: datex_core
             CARGO_INCREMENTAL: 0
         steps:
-            - uses: actions/checkout@v4
+            - uses: actions/checkout@v5
 
             - name: Install libudev-dev and pkg-config
               run: |
@@ -22,7 +22,7 @@ jobs:
             - name: Install Deno
               uses: denoland/setup-deno@v2
               with:
-                deno-version: v2.x
+                  deno-version: v2.x
 
             - uses: dtolnay/rust-toolchain@stable
               with:
@@ -52,9 +52,48 @@ jobs:
                   cargo nextest run --profile ci --features debug;
             - name: Run Struct Tests
               run: deno task test
+
+            - name: Run cargo publish dry-run (release branches only)
+              if: startsWith(github.head_ref, 'release/')
+              run: |
+                  echo "Running cargo publish dry-run..."
+                  cargo publish --dry-run
+
             - name: Upload test results
               uses: EnricoMi/publish-unit-test-result-action@v2
               with:
                   check_name: Test Results
                   github_token: ${{ secrets.GITHUB_TOKEN }}
                   files: target/nextest/ci/report.xml
+    test-embedded:
+        runs-on: macos-latest
+        name: Test
+        concurrency:
+            group: ${{ github.workflow }}-${{ github.ref }}-test-embedded
+            cancel-in-progress: true
+
+        steps:
+            - uses: actions/checkout@v5
+
+            - uses: dtolnay/rust-toolchain@stable
+              with:
+                  toolchain: nightly
+                  components: clippy
+            - run: rustup target add thumbv7em-none-eabihf
+
+            - name: Cache dependencies
+              uses: actions/cache@v4
+              env:
+                  cache-name: cache-dependencies
+              with:
+                  path: |
+                      ~/.cargo/.crates.toml
+                      ~/.cargo/.crates2.json
+                      ~/.cargo/bin
+                      ~/.cargo/registry/index
+                      ~/.cargo/registry/cache
+                      target
+                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }}
+
+            - name: Test nostd build
+              run: cargo build --no-default-features --features embedded,debug --target thumbv7em-none-eabihf
diff --git a/.github/workflows/todo-extractor.yml b/.github/workflows/todo-extractor.yml
@@ -4,7 +4,7 @@ on:
     workflow_dispatch:
     push:
         branches:
-            - "release/*"
+            - "main"
 
 concurrency:
     group: ${{ github.workflow }}
@@ -19,10 +19,20 @@ jobs:
     Datex-tractor:
         runs-on: ubuntu-latest
         steps:
+            - name: Gen app token...
+              id: app-token
+              uses: tibdex/github-app-token@v2
+              with:
+                  app_id: ${{ secrets.DATEX_TRACTOR_ID }}
+                  private_key: ${{ secrets.DATEX_TRACTOR_PRI_KEY }}
+
             - name: Checkout own repo
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
+              with:
+                  token: ${{ steps.app-token.outputs.token }}
 
             - name: Run datex_tractor
-              uses: unyt-org/datex-tractor@r0.0.3
+              uses: unyt-org/datex-tractor@v0.0.1
               with:
-                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  # github_token: ${{ secrets.GITHUB_TOKEN }}
+                  github_token: ${{ steps.app-token.outputs.token }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,35 +1,44 @@
-# Contributing to **DATEX Core**
+# Contributing to **DATEX Core**
 
 This document describes the workflow, branch strategy, coding standards, and
-quality gates for contributing to
-the [`datex-core`](https://github.com/unyt-org/datex-core) Rust crate.
+quality gates for contributing to the
+[`datex-core`](https://github.com/unyt-org/datex-core) Rust crate.
 
 ---
 
 ## Workflow & Branch Strategy
 
 | Purpose                        | Naming Pattern                    | Example                 |
 | ------------------------------ | --------------------------------- | ----------------------- |
-| **Permanent default branch**   | `main`                            | —                       |
+| **Permanent default branch**   | `main`                            | -                       |
 | **Milestone / release branch** | `release/<MAJOR>.<MINOR>.<PATCH>` | `release/0.0.4`         |
 | **Feature branch**             | `feature/<slug>`                  | `feature/tcp-interface` |
 | **Bug-fix branch**             | `fix/<slug>`                      | `fix/handshake-timeout` |
 | **Maintenance / chore branch** | `chore/<slug>`                    | `chore/update-deps`     |
+| **Hotfix branch**              | `hotfix/<slug>`                   | `hotfix/crash-on-start` |
 
-1. **`main` is protected** – direct pushes are disabled.
+> Use **lowercase letters** and **hyphens** (`-`) in branch names. Avoid spaces,
+> underscores (`_`), or other special characters.
+
+1. The default branch **`main` is protected** – direct pushes are disabled.
 2. **All work happens via Pull Requests (PRs).**
 3. **Target branch for every PR is the currently-active release branch** (e.g.
    `release/0.0.4`).
-4. After review & CI success, the feature branch is **squash-merged** into the
-   release branch.
+4. After review & CI success, the feature branch is **merged** into the release
+   branch.
 5. Release branches are merged back to `main` only by a maintainer at version
    cut-time.
 
+> **Do not branch from or target `main`** for new work. All development must
+> branch from the **latest release branch** (e.g., `release/0.0.4`). The `main`
+> branch reflects only published, production-ready code and is not used for
+> active development.
+
 ---
 
 ## Coding Style
 
-- **Edition:** Rust 2024.
+- **Edition:** Rust 2024.
 
 - **Formatting:**
 
@@ -45,19 +54,19 @@ the [`datex-core`](https://github.com/unyt-org/datex-core) Rust crate.
   cargo clippy --features debug
   ```
 
-  _We plan to treat all Clippy warnings as errors in the future._ Suppress a
+  _We plan to treat more Clippy warnings as errors in the future._ Suppress a
   lint only with a line-level `#[allow(lint_name)]` and an explanatory comment.
 
 - **Idioms & Practices:**
 
   - Prefer explicit `use` paths; group imports by crate.
   - Enable useful nightly lints in `#![deny(clippy::pedantic, clippy::nursery)]`
     where feasible.
-  - No `unsafe` unless unavoidable - must include a safety comment explaining
+  - No `unsafe` unless unavoidable – must include a safety comment explaining
     invariants.
   - Public items require rustdoc comments (`///`) with examples where possible.
-  - Follow **snake\_case** for variables/functions, **CamelCase** for
-    types/traits, **SCREAMING\_SNAKE\_CASE** for constants.
+  - Follow **snake_case** for variables/functions, **CamelCase** for
+    types/traits, **SCREAMING_SNAKE_CASE** for constants.
 
 ---
 
@@ -103,22 +112,24 @@ the [`datex-core`](https://github.com/unyt-org/datex-core) Rust crate.
 - Place Criterion benchmarks in `benches/`.
 - Benchmarks must compile and run (CI executes them with `--bench` but does not
   time-gate results).
-- Performance regressions > 10 % should be called out in the PR description.
+- Performance regressions > 10 % should be called out in the PR description.
 
 ---
 
 ## Continuous Integration Gates
 
 A pull request is **merge-ready** only when:
 
-1. All unit tests pass: `cargo test --all`.
-2. All integration tests pass: `cargo test --all --tests`.
+1. All unit tests pass: `cargo test --all --features debug`.
+2. All integration tests pass: `cargo test --all --tests --features debug`.
 3. All benchmarks build: `cargo bench --no-run`.
-4. Clippy passes with no errors
-5. Rustfmt check passes
+4. Clippy passes with no errors.
+5. Rustfmt check passes.
 6. Checks complete on all supported toolchains (currently stable, beta).
 
-CI will automatically block a PR that fails any step.
+> **Note:** CI pipelines are automatically triggered for all PRs targeting
+> release branches. PRs to `main` will be rejected unless explicitly opened by a
+> maintainer.
 
 ---
 
@@ -136,21 +147,55 @@ Before requesting review, ensure you have:
 
 ---
 
+## How to Make Changes & Open a PR
+
+1. **Always base your work on the latest release branch**, _not_ on `main`. The
+   `main` branch only tracks finalized releases - new development happens in the
+   currently active `release/x.y.z` branch.
+
+2. **Creating your branch:**
+
+   ```bash
+   git fetch origin
+   git checkout origin/release/<MAJOR>.<MINOR>.<PATCH> -b feature/<slug>
+   ```
+
+3. **When your feature or fix is ready:**
+
+   - Open a Pull Request (PR) targeting the same **release branch** you based
+     your work on.
+   - Select the [**"DATEX"**](https://github.com/orgs/unyt-org/projects/12)
+     project for the PR in GitHub.
+   - The **maintainers** will assign it to the appropriate **release
+     milestone**.
+
+4. If your PR cannot be merged cleanly (e.g., due to version conflicts), it may
+   be retargeted to a later release branch by maintainers.
+
+5. Once approved, your change will be **merged** into the active release branch;
+   the release branch will later be merged back into `main` during version cut.
+
+---
+
 ## Commit & PR Hygiene
 
 - Use **Conventional Commits** style (e.g. `feat: add TCP interface`,
   `fix: handle timeout`).
 - Keep commit history clean; squash or amend while the PR is open.
-- Reference issues in the PR body (e.g. `Closes #42`).
+- Reference issues in the PR body (e.g. `fix #42`).
 
 ---
 
 ## Communication
 
-- Small changes (< 30 LoC) may be approved by one maintainer; larger or
+- Small changes (< 30 LoC) may be approved by one maintainer; larger or
   architectural changes require two approvals.
-- Discuss API-breaking changes in a GitHub Issue before coding.
-- Feel free to draft a PR early (`[WIP]`) to get feedback on direction.
+- Discuss API-breaking changes in a GitHub
+  [Issue](https://github.com/unyt-org/datex-core/issues) or
+  [Discussion](https://github.com/unyt-org/datex-core/discussions) before
+  coding.
+- Feel free to draft a PR early (`[WIP]`) and mark as draft to get feedback on
+  direction.
 
 ---