Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 47 additions & 8 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,25 +46,59 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Remove empty Rules directories
run: find Rules -type d -empty -delete
- name: Remove test directory
run: rm -r Rules/Languages/zz
- name: create Rules.zip
run: zip -r Rules.zip Rules
- uses: dtolnay/rust-toolchain@stable
- name: Create Rules.zip
run: cargo run --bin package-rules -- Rules Rules.zip
- name: Create Rules-minimized.zip
run: cargo run --bin package-rules -- Rules Rules-minimized.zip --minimize
- name: Upload Rules.zip
uses: actions/upload-artifact@v7
with:
name: 'Rules.zip'
path: 'Rules.zip'
compression-level: 0
retention-days: 1
- name: Upload Rules-minimized.zip
uses: actions/upload-artifact@v7
with:
name: 'Rules-minimized.zip'
path: 'Rules-minimized.zip'
compression-level: 0
retention-days: 1

test-rules-package:
name: Test (${{ matrix.feature_name }}, ${{ matrix.rules_zip }})
needs: zip-rules
strategy:
fail-fast: false
matrix:
rules_zip: [Rules.zip, Rules-minimized.zip]
include:
- feature_name: default
features: ""
- feature_name: no-unsafe
features: "--features no-unsafe"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Download ${{ matrix.rules_zip }}
uses: actions/download-artifact@v8
with:
name: ${{ matrix.rules_zip }}
- name: Install packaged Rules
run: |
rm -rf Rules
unzip -q "${{ matrix.rules_zip }}"
# Release zips omit the synthetic zz test language; restore it for unit tests only.
git checkout HEAD -- Rules/Languages/zz
- name: Run tests (${{ matrix.feature_name }})
run: cargo test ${{ matrix.features }} --verbose

pre-release:
name: Pre Release
continue-on-error: false
if: github.event_name == 'push' && github.ref == 'refs/heads/main' # otherwise, job fails on pull requests, as GITHUB_TOKEN is not available
needs: [build, clippy, zip-rules]
needs: [build, clippy, zip-rules, test-rules-package]
runs-on: ubuntu-latest
permissions:
contents: write
Expand All @@ -73,6 +107,10 @@ jobs:
uses: actions/download-artifact@v8
with:
name: Rules.zip
- name: download Rules-minimized.zip
uses: actions/download-artifact@v8
with:
name: Rules-minimized.zip
# Moving 'latest' prerelease (replaces marvinpinto/action-automatic-releases)
- name: Development Build release
env:
Expand All @@ -90,4 +128,5 @@ jobs:
--latest=false \
--title "Development Build" \
--notes "Development build from ${SHA}" \
Rules.zip
Rules.zip \
Rules-minimized.zip
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
target
build.rs.orig
Python/libmathcat.pyd
Cargo.lock
src-pest.7z
src.7z
mp2.7z
Expand Down
6 changes: 4 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ but add common mistakes of AI agents here instead.
- Common per-language files:
- `ClearSpeak_Rules.yaml`, `SimpleSpeak_Rules.yaml`
- `SharedRules/`, `unicode.yaml`, `unicode-full.yaml`, `definitions.yaml`, `navigate.yaml`
- `build.rs` can bundle rules into `rules.zip` when `include-zip` is enabled.
- `build.rs` can bundle rules into `rules.zip` when `include-zip` is enabled (always the minimized tree). Shared zipper: `src/rules_archive.rs`, invoked as `cargo run --bin package-rules -- Rules <output> [--minimize]`.
- CI packages `Rules.zip` (verbatim) and `Rules-minimized.zip` (comments stripped from `Languages/**/unicode.yaml` and `unicode-full.yaml` only). Each language/braille subdir is stored as `<name>/<name>.zip`; top-level and `Intent/` YAML stay loose. Inner language zips use BZIP2; the outer downloadable archive uses DEFLATE so `unzip` works. Both omit `Languages/zz`; the `test-rules-package` job restores `zz` from git after unzip so unit tests still run against release-like archives.

## Translation Conventions
- `t:` means untranslated or unverified.
Expand All @@ -26,12 +27,13 @@ but add common mistakes of AI agents here instead.
- In sandboxed runs, if needed:
- set `UV_CACHE_DIR=/tmp/uv-cache`
- rerun with escalated permissions if macOS `system-configuration` panics occur.
- *always* self-validate: `ùv run pytest`
- self-validate appropriately with: `uv run pytest`

## Agent Instructions
- Do not mirror README content here; keep guidance agent-specific.
- Avoid broad formatting sweeps; do not run `cargo fmt` in this repo.
- Keep code/rule changes focused and validate with targeted tests first: `cargo test <relevant-tests>`
- Do **not** change test goldens (expected braille/speech/nav strings) unless the user explicitly says to. Prefer fixing code/rules to match existing goldens; if a golden looks wrong vs the spec, ask before editing it.
- do not do any git commands unless explicitly asked for
- Rust coverage is in `target/coverage/`.
- When working with GitHub, e.g. looking at PRs and issues, check if the GitHub CLI is installed (`gh --version`).
Expand Down
Loading
Loading