update readme and add action
Some checks failed
Release crate / Publish to crates.io and create GitHub Release (release) Failing after 1m38s
Some checks failed
Release crate / Publish to crates.io and create GitHub Release (release) Failing after 1m38s
This commit is contained in:
63
.github/workflows/release.yml
vendored
Normal file
63
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
name: Release crate
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Publish to crates.io and create GitHub Release
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Install Rust
|
||||||
|
uses: dtolnay/rust-toolchain@stable
|
||||||
|
|
||||||
|
- name: Cache cargo registry and git index
|
||||||
|
uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/registry
|
||||||
|
~/.cargo/git
|
||||||
|
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||||
|
|
||||||
|
- name: Build and test
|
||||||
|
run: cargo test --workspace --verbose
|
||||||
|
|
||||||
|
- name: Install cargo-edit and set crate version
|
||||||
|
id: set_version
|
||||||
|
run: |
|
||||||
|
# install cargo-edit (provides `cargo set-version`)
|
||||||
|
cargo install cargo-edit --locked --force
|
||||||
|
TAG="${{ github.event.release.tag_name }}"
|
||||||
|
# strip a leading 'v' if present
|
||||||
|
VERSION="${TAG#v}"
|
||||||
|
cargo set-version "$VERSION" --workspace
|
||||||
|
# expose the version for later steps
|
||||||
|
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Publish to crates.io
|
||||||
|
env:
|
||||||
|
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
|
||||||
|
run: |
|
||||||
|
if [ -z "$CARGO_REGISTRY_TOKEN" ]; then
|
||||||
|
echo "CARGO_REGISTRY_TOKEN is not set. Set it in repository secrets to publish to crates.io"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
cargo publish --token "$CARGO_REGISTRY_TOKEN" --allow-dirty
|
||||||
|
|
||||||
|
- name: Create GitHub Release
|
||||||
|
uses: softprops/action-gh-release@v1
|
||||||
|
with:
|
||||||
|
tag_name: ${{ github.ref_name }}
|
||||||
|
name: Release ${{ steps.set_version.outputs.version }}
|
||||||
|
body: |
|
||||||
|
This release publishes the crate version `${{ steps.set_version.outputs.version }}` to crates.io:
|
||||||
|
|
||||||
|
https://crates.io/crates/schafkopf-logic/${{ steps.set_version.outputs.version }}
|
||||||
|
|
||||||
|
Git tag: ${{ github.ref_name }}
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -2,4 +2,5 @@ target
|
|||||||
Cargo.lock
|
Cargo.lock
|
||||||
shell.nix
|
shell.nix
|
||||||
dist
|
dist
|
||||||
generated_cards
|
generated_cards
|
||||||
|
main.rs
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "schafkopf-logic"
|
name = "schafkopf-logic"
|
||||||
version = "0.1.0"
|
version = "0.0.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
description = "Logic and rules for the Schafkopf card game: deck, suits, ranks and game modes."
|
description = "Logic and rules for the Schafkopf card game: deck, suits, ranks and game modes."
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -14,7 +14,7 @@ Logic and rules for the German card game Schafkopf. This crate provides types
|
|||||||
and helpers for deck construction, common game modes and basic trick-taking
|
and helpers for deck construction, common game modes and basic trick-taking
|
||||||
logic.
|
logic.
|
||||||
|
|
||||||
**Crate:** `schafkopf-logic` • **Version:** 0.1.0
|
**Crate:** [`schafkopf-logic`](https://crates.io/crates/schafkopf-logic)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -36,13 +36,13 @@ fn main() {
|
|||||||
deck.shuffle();
|
deck.shuffle();
|
||||||
let hands = deck.deal_4x8().expect("deck should contain 32 cards");
|
let hands = deck.deal_4x8().expect("deck should contain 32 cards");
|
||||||
|
|
||||||
// form a sample trick from the first card of each hand
|
// Form a sample trick from the first card of each hand and print it
|
||||||
let trick = [&hands[0][0], &hands[1][0], &hands[2][0], &hands[3][0]];
|
let trick = [&hands[0][0], &hands[1][0], &hands[2][0], &hands[3][0]];
|
||||||
let winner = Gamemode::Sauspiel(Suit::Herz).winning_card(trick);
|
println!("Trick: {}, {}, {}, {}", trick[0], trick[1], trick[2], trick[3]);
|
||||||
println!("Winning card: {}", winner);
|
|
||||||
|
|
||||||
// rank points example
|
// Determine the winner for a sample game mode (Sauspiel with Schell)
|
||||||
assert_eq!(Rank::Ass.points(), 11);
|
let winner = Gamemode::Sauspiel(Suit::Schell).winning_card(trick);
|
||||||
|
println!("Winning card: {}", winner);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user