Skip to content

Commit

Permalink
Merge pull request #9 from craigfay/feature/add-unit-test-action
Browse files Browse the repository at this point in the history
[FEATURE] Add GitHub Action Workflow for Unit Testing
  • Loading branch information
aeronavery committed Nov 6, 2022
2 parents 0e72af9 + b720653 commit be26d50
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/unit_tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Unit Tests

on:
push:
branches: [ "main" ]

pull_request:
branches: [ "main" ]

workflow_dispatch:

jobs:
test:
strategy:
matrix:
runner-os: [ubuntu-latest]
zig-version: [ '0.9.1', ]
runs-on: ${{ matrix.runner-os }}
name: "zig v${{ matrix.zig-version }} on ${{ matrix.runner-os }}"
steps:
- name: Checkout Correct Branch
uses: actions/checkout@v2
- name: Install Zig
uses: goto-bus-stop/setup-zig@v1
with:
version: ${{ matrix.zig-version }}
- name: Run Unit Tests
run: zig test src/toml.zig
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
[![Build Status](https://github.com/aeronavery/zig-toml/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/aeronavery/zig-toml/actions/workflows/unit_tests.yml)

# zig-toml
A TOML parser written in Zig targeting [TOML v0.5.0](https://github.com/toml-lang/toml). The end goal is for the program to be robust, with no crashing given any situation. Though, in its current state this program is probably far from that goal.

There is currently a lack of documentation but the tests contained should give enough of an idea on how to use this.

[Quickstart Guide](https://github.com/darithorn/zig-toml/wiki/Quickstart-Guide)

## Zig Version Support
This table shows the project's current compatibility status with zig:

| Zig Version | Status |
| -- | -- |
| [0.9.1](https://ziglang.org/documentation/0.9.1/) | Supported |
| [0.8.1 and below](https://ziglang.org/documentation/0.8.1/) | Not Supported |


## Features
- [x] Tables
- [x] Keys (all kinds)
Expand Down

0 comments on commit be26d50

Please sign in to comment.