Skip to content

Commit

Permalink
feat: overhaul oasysdb (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
edwinkys authored Aug 1, 2024
2 parents 0df69f8 + 84c2b19 commit 5d1f639
Show file tree
Hide file tree
Showing 82 changed files with 4,848 additions and 6,412 deletions.
1 change: 1 addition & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ charset = utf-8
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
max_line_length = 80

[*.{rs, py}]
indent_size = 4
Expand Down
2 changes: 0 additions & 2 deletions .env.example

This file was deleted.

11 changes: 7 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: 🐞 Report a bug
name: 🐞 Report Bug
about: Report an unexpected behavior or a malfunctioning feature.
title: "BUG:"
labels: bug
Expand All @@ -8,11 +8,13 @@ assignees: ""

### Short description

What is the bug about? Please provide a clear and concise description of what the bug is. If applicable, include the error message that you received.
What is the bug about? Please provide a clear and concise description of what
the bug is. If applicable, include the error message that you received.

### Steps to reproduce

How can the bug be reproduced? Please provide a minimal set of steps to reproduce the behavior.
How can the bug be reproduced? Please provide a minimal set of steps to
reproduce the behavior.

Example:

Expand All @@ -29,4 +31,5 @@ How severe is the bug? Are you using OasysDB in production?

### Additional context

Add any other context about the problem here. For example, screenshots, screen recordings, or logs.
Add any other context about the problem here. For example, screenshots, screen
recordings, or logs.
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
blank_issues_enabled: false

contact_links:
- name: ❓ Ask a question
- name: ❓ Ask Question
url: https://github.com/oasysai/oasysdb/discussions
about: Ask general questions or share ideas on Discussions.

- name: 💬 Join Discord
url: https://discord.gg/bDhQrkqNP4
about: Join the Discord server to help shape the future of OasysDB.
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/do_chore.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: 🧹 Do a chore
name: 🧹 Do Chore
about: Documentation updates, code refactoring, or other chores.
title: "CHORE:"
labels: chore
Expand All @@ -8,7 +8,8 @@ assignees: ""

### Description

What is the chore about? Please provide a clear and concise description of what the chore is.
What is the chore about? Please provide a clear and concise description of what
the chore is.

Chore examples:

Expand All @@ -18,4 +19,5 @@ Chore examples:

### Why is this beneficial?

Why do you think this chore is needed? Is it related to a problem that you encounter that are not related to a bug or a feature request?
Why do you think this chore is needed? Is it related to a problem that you
encounter that are not related to a bug or a feature request?
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: 🛠️ Request a feature
name: 🛠️ Feature Request
about: Request a new feature or an improvement to an existing feature.
title: "FEAT:"
labels: enhancement
Expand All @@ -8,14 +8,18 @@ assignees: ""

### Use case

What's the use case for this feature? Is it related to a problem that you encounter? Please provide a clear and concise description of what the feature is about.
What's the use case for this feature? Is it related to a problem that you
encounter? Please provide a clear and concise description of what the feature is
about.

### Proposed solution

On the high level, how would you like the feature to be implemented? Why do you think this is the best solution?
On the high level, how would you like the feature to be implemented? Why do you
think this is the best solution?

Do you have any alternative solutions?

### Additional context

Add additional context about the feature request. Like, screenshots, links to related issues, or other relevant information.
Add additional context about the feature request. Like, screenshots, links to
related issues, or other relevant information.
72 changes: 72 additions & 0 deletions .github/workflows/database-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Test Database

on:
workflow_dispatch:

pull_request:
paths-ignore:
- "docs/**"
- "clients/**"

push:
branches:
- main
paths-ignore:
- "docs/**"
- "clients/**"

jobs:
rustfmt-format:
name: Check code formatting
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@v4

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt

- name: Run cargo fmt with check
run: cargo fmt -- --check

clippy-lint:
name: Lint code with Clippy
needs: rustfmt-format
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@v4

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: clippy

- name: Install Protobuf compiler
run: |
sudo apt update && sudo apt upgrade -y
sudo apt install -y protobuf-compiler libprotobuf-dev
- name: Run cargo clippy
run: cargo clippy -- -D warnings

run-rust-tests:
name: Run Rust tests
needs: clippy-lint
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@v4

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Install Protobuf compiler
run: |
sudo apt update && sudo apt upgrade -y
sudo apt install -y protobuf-compiler libprotobuf-dev
- name: Run cargo test
run: cargo test --all-features -- --test-threads 1
136 changes: 0 additions & 136 deletions .github/workflows/deploy-python.yml

This file was deleted.

26 changes: 0 additions & 26 deletions .github/workflows/deploy-rust.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish documentation website
name: Publish Docs

on:
workflow_dispatch:
Expand Down Expand Up @@ -41,7 +41,7 @@ jobs:
runs-on: ubuntu-latest
needs: build-docs
environment:
name: documentation
name: Docs
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
Expand Down
Loading

0 comments on commit 5d1f639

Please sign in to comment.