Skip to content

Commit

Permalink
Set up the repository
Browse files Browse the repository at this point in the history
This commit performs initial repository setup, including adding a
README, basic project structure, CI, and other necessary things.
  • Loading branch information
iamrecursion committed Sep 3, 2024
0 parents commit bdccadc
Show file tree
Hide file tree
Showing 17 changed files with 1,102 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# General Code
* @reilabs/starkware
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Bug report
about: Found something wrong? Let us know.
title: "[BUG] "
labels: bug
assignees: ''
---

# Describe the Bug

A clear and concise description of what the bug is.

# To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

# Expected Behaviour

A clear and concise description of what you expected to happen.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature
about: A new feature to be added.
title: "[FEAT] "
labels: enhancement
assignees: ''
---

# Description

What is this about?

# Spec

Give details.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Performance
about: An opportunity for performance improvement or other performance-related work.
title: "[PERF] "
labels: enhancement
assignees: ''
---

# Description

What is this about?

# Spec

Give details.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Task
about: A development task to be done.
title: "[TASK] "
labels: enhancement
assignees: ''
---

# Description

What is this about?

# Spec

Give details.
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Summary

<!-- What is this PR about? -->

# Details

<!-- What do you want the reviewers to focus on? Anything important that they should know? -->

# Checklist

- [ ] Code is formatted by Rustfmt.
- [ ] Documentation has been updated if necessary.
119 changes: 119 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Metadata for the actions workflow
name: CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "*" ]

# Environment variables that will be set on all runners
env:
CI_DEV_SHELL: "nix develop '.#ci'"
CARGO_TERM_COLOR: always # Always colour Cargo's output.
CARGO_INCREMENTAL: 0 # Always run without incremental builds on CI.
CARGO_PROFILE_DEV_DEBUG: 0 # Don't embed debug info even though the build is a dev build.

# Configuration for individual jobs
jobs:

# This job is responsible for running the unit and integration tests.
test:
name: "Test"
strategy:
fail-fast: false
matrix:
os: [ "ubuntu-latest", "macos-latest" ]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Restore Nix Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
/nix/store
key: nix-${{ hashFiles('**/flake.lock') }}-${{ matrix.os }}
- name: Restore Rust Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
target/
key: rust-${{ hashFiles('**/Cargo.lock') }}-${{ matrix.os }}
- name: Install Lix
shell: "bash"
run: |
curl -sSf -L https://install.lix.systems/lix | sh -s -- install --no-confirm
- name: Build Lix Dependencies
shell: "bash"
run: |
nix build
- name: Build Tests
shell: "bash"
run: |
${{ env.CI_DEV_SHELL }} --command cargo test --all-targets --no-run
- name: Run Tests
shell: "bash"
run: |
${{ env.CI_DEV_SHELL }} --command cargo test --all-targets -- --nocapture
# This job runs the linter.
lint:
name: "Lint"
runs-on: "ubuntu-latest"
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Restore Nix Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
/nix/store
key: nix-${{ hashFiles('**/flake.lock') }}-${{ matrix.os }}
- name: Restore Rust Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
target/
key: rust-${{ hashFiles('**/Cargo.lock') }}-${{ matrix.os }}
- name: Install Lix
shell: "bash"
run: |
curl -sSf -L https://install.lix.systems/lix | sh -s -- install --no-confirm
- name: Lint Code
shell: "bash"
run: |
${{ env.CI_DEV_SHELL }} --command cargo clippy --all-targets
# This job checks the code formatting.
formatting:
name: "Check Formatting"
runs-on: "ubuntu-latest"
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Restore Nix Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
/nix/store
key: nix-${{ hashFiles('**/flake.lock') }}-${{ matrix.os }}
- name: Restore Rust Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
target/
key: rust-${{ hashFiles('**/Cargo.lock') }}-${{ matrix.os }}
- name: Install Lix
shell: "bash"
run: |
curl -sSf -L https://install.lix.systems/lix | sh -s -- install --no-confirm
- name: Check Formatting
shell: "bash"
run: |
${{ env.CI_DEV_SHELL }} --command cargo fmt --all -- --check
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Rust
/target

# Tooling
.idea/
result
Loading

0 comments on commit bdccadc

Please sign in to comment.