10000 Enhance README documentation and add CI jobs (#10) · Rust-Python-Packaging/pyver@4363928 · GitHub
[go: up one dir, main page]

Skip to content

Commit 4363928

Browse files
authored
Enhance README documentation and add CI jobs (#10)
* Add more additional info and status badges to the README. * Add CI jobs covering `ubuntu`, `windows`, `macos` with `stable`, `beta`, `nightly` toolchains, and some other misc CI jobs.
1 parent ab433a5 commit 4363928

File tree

15 files changed

+422
-137
lines changed

15 files changed

+422
-137
lines changed

.github/workflows/build.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 🔨 Build
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main", "develop"]
7+
8+
env:
9+
CARGO_TERM_COLOR: always
10+
11+
jobs:
12+
build:
13+
strategy:
14+
matrix:
15+
os: [ubuntu-latest, windows-latest, macos-latest]
16+
toolchain: [stable, beta, nightly]
17+
name: 🔨 Build release
18+
runs-on: ${{ matrix.os }}
19+
steps:
20+
- uses: actions/checkout@v2
21+
- name: Install latest ${{ matrix.toolchain }}
22+
uses: actions-rs/toolchain@v1
23+
with:
24+
toolchain: ${{ matrix.toolchain }}
25+
- uses: actions/cache@v3
26+
with:
27+
path: |
28+
~/.cargo/bin/
29+
~/.cargo/registry/index/
30+
~/.cargo/registry/cache/
31+
~/.cargo/git/db/
32+
target/
33+
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
34+
- name: Build release
35+
run: cargo build --release
36+

.github/workflows/checks.yml

Lines changed: 0 additions & 106 deletions
This file was deleted.

.github/workflows/docs.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 📄 Build docs
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main", "develop"]
7+
8+
env:
9+
CARGO_TERM_COLOR: always
10+
11+
jobs:
12+
docs:
13+
name: 📄 Build docs
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Build docs
18+
run: cargo doc --verbose

.github/workflows/format.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: 👔 Check formatting
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main", "develop"]
7+
8+
env:
9+
CARGO_TERM_COLOR: always
10+
11+
jobs:
12+
check_format:
13+
name: 👔 Check formatting
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Check Formatting
18+
run: cargo fmt -- --verbose --check --color auto
19+

.github/workflows/lint.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🖋 Check linting
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main", "develop"]
7+
8+
env:
9+
CARGO_TERM_COLOR: always
10+
11+
jobs:
12+
check_lint_rust:
13+
name: 🖋 Check linting
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Check linting
18+
run: |
19+
rustup component add clippy
20+
set env RUSTFLAGS="-Dwarnings"
21+
cargo clippy --workspace -- -D warnings
22+
check_lint_markdown:
23+
name: 🖋 Check markdown files
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Check out code
27+
uses: actions/checkout@v2
28+
- name: Markdown Linting Action
29+
uses: avto-dev/markdown-lint@v1.5.0
30+
with:
31+
args: "*.md"

.github/workflows/md_checks.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

.github/workflows/package.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 📦 Package
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main", "develop"]
7+
8+
env:
9+
CARGO_TERM_COLOR: always
10+
11+
jobs:
12+
license:
13+
name: 🏫 License check
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Check license
18+
run: |
19+
cargo install cargo-deny
20+
cargo deny check
21+
22+
cargo_check:
23+
name: 📦 Check package integrity
24+
runs-on: ubuntu-latest
25+
steps:
26+
- uses: actions/checkout@v2
27+
- name: Check package integrity
28+
run: cargo package --verbose
29+
30+
publish_dry_run:
31+
name: 📢 Publish dry-run
32+
runs-on: ubuntu-latest
33+
steps:
34+
- uses: actions/checkout@v2
35+
- name: Publish dry run
36+
run: cargo publish --dry-run --verbose

.github/workflows/tests.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: 🧪 Tests
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main", "develop"]
7+
8+
env:
9+
CARGO_TERM_COLOR: always
10+
11+
jobs:
12+
test:
13+
strategy:
14+
matrix:
15+
os: [ubuntu-latest, windows-latest, macos-latest]
16+
toolchain: [stable, beta, nightly]
17+
name: 🧪 Run tests
18+
runs-on: ${{ matrix.os }}
19+
steps:
20+
- uses: actions/checkout@v2
21+
- name: Install latest ${{ matrix.toolchain }}
22+
uses: actions-rs/toolchain@v1
23+
with:
24+
toolchain: ${{ matrix.toolchain }}
25+
- uses: actions/checkout@v2
26+
- name: Run tests
27+
run: cargo test --verbose
28+

.rustfmt.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
max_width = 88

CHANGELOG.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@
33

44
# Changelog
55

6-
All notable changes to this project will be documented in this file.
6+
<!-- All notable changes to this project will be documented in this file.
7+
The format is based on :
78
8-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
9-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9+
* [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
10+
and this project adheres to:
11+
* [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -->
12+
13+
## Unreleased
1014

1115
## [0.0.1] - 2022-09-03
1216

1317
### Added
1418

15-
- Created Baseline Project
19+
* Created Baseline Project

0 commit comments

Comments
 (0)
0