Skip to content

Commit

Permalink
add github actions, update readme in prep for first alpha release
Browse files Browse the repository at this point in the history
  • Loading branch information
boldandbrad committed Mar 18, 2024
1 parent 9d6109a commit 5e1787a
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/publish-crate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: publish crate

on:
push:
tags:
- "v*" # Push events to every tag containing v
workflow_dispatch:

jobs:
publish:
name: Publish
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4

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

- name: Cargo Publish
run: cargo publish --token ${CRATES_TOKEN}
env:
CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
29 changes: 29 additions & 0 deletions .github/workflows/rust-ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: ci

on: [push, pull_request]

jobs:
ci:
name: CI
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4

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

- name: Install cargo-audit
run: cargo install cargo-audit

- name: Build
run: cargo build --verbose

- name: Test
run: cargo test --verbose

- name: Lint
run: cargo clippy -- -D warnings

- name: Audit
run: cargo audit
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# euchre-tui

[![Crates.io](https://img.shields.io/crates/v/euchre-tui)](https://crates.io/crates/euchre-tui)

Euchre is a team-based trick-taking card game for 4 players that is popular in
the US Midwest, and some other places.

Expand All @@ -21,6 +23,12 @@ designed text-based interface.
<!-- TODO: add install instructions -->

## 📦 Install <a id="install"></a>

```bash
cargo install euchre-tui
```

## ⚖️ Legal <a id="legal"></a>

Copyright (c) 2024 Bradley Wojcik. Released under the MIT License. See
Expand Down

0 comments on commit 5e1787a

Please sign in to comment.