@ifi/oh-pi-skills 0.2.8 → 0.2.10

package/skills/rust-workspace-bootstrap/template/.github/actions/devenv/action.yml

@@ -0,0 +1,42 @@
+name: devenv
+description: Setup development environment with devenv
+inputs:
+  github-token:
+    description: Provide a GitHub token
+    required: true
+  cache-version:
+    description: Cache version for dependency keys
+    required: false
+    default: "v1"
+
+runs:
+  using: composite
+  steps:
+    - name: cache rust dependencies
+      uses: Swatinem/rust-cache@v2
+      with:
+        prefix-key: "${{ inputs.cache-version }}"
+
+    - name: cache cargo binaries
+      uses: actions/cache@v4
+      with:
+        path: ./.bin
+        key: ${{ runner.os }}-cargo-bin-${{ inputs.cache-version }}-${{ env.RUSTUP_TOOLCHAIN }}-${{ hashFiles('rust-toolchain.toml', 'Cargo.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-cargo-bin-${{ inputs.cache-version }}-
+
+    - name: install nix
+      uses: cachix/install-nix-action@v31
+      with:
+        github_access_token: ${{ inputs.github-token }}
+
+    - name: setup nix environment
+      run: |
+        nix profile add --accept-flake-config nixpkgs#cachix
+        cachix use devenv
+        nix profile add nixpkgs#devenv
+      shell: bash
+
+    - name: install dependencies
+      run: install:cargo:bin
+      shell: devenv shell -- bash -e {0}

package/skills/rust-workspace-bootstrap/template/.github/workflows/ci.yml

@@ -0,0 +1,130 @@
+name: "ci"
+permissions:
+  contents: read
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  commit-lint:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: validate commit messages
+        run: |
+          PATTERN='^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?!?: .+'
+
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            BASE_SHA='${{ github.event.pull_request.base.sha }}'
+            HEAD_SHA='${{ github.event.pull_request.head.sha }}'
+            COMMITS=$(git log --format='%s' --no-merges "${BASE_SHA}..${HEAD_SHA}")
+          else
+            COMMITS=$(git log --format='%s' -1)
+          fi
+
+          FAILED=0
+          while IFS= read -r msg; do
+            [ -z "$msg" ] && continue
+            if ! echo "$msg" | grep -qE "$PATTERN"; then
+              echo "::error::Invalid commit message: '$msg'"
+              FAILED=1
+            fi
+          done <<< "$COMMITS"
+
+          if [ "$FAILED" -eq 1 ]; then
+            exit 1
+          fi
+
+  changeset:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request' || !startsWith(github.event.head_commit.message, 'chore: prepare releases')
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: check for changeset
+        run: |
+          CHANGESETS=$(find .changeset -name '*.md' ! -name 'README.md' 2>/dev/null | wc -l | tr -d ' ')
+          if [ "$CHANGESETS" -eq 0 ]; then
+            echo "::error::No changeset found. Run 'knope document-change'."
+            exit 1
+          fi
+          echo "✅ Found $CHANGESETS changeset(s)"
+
+  lint:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: lint
+        run: lint:all
+        shell: devenv shell -c -- bash -e {0}
+
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: run tests
+        run: test:all
+        shell: devenv shell -c -- bash -e {0}
+
+  build:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    needs: [commit-lint, changeset, lint, test]
+    if: ${{ !failure() && !cancelled() }}
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: build default features
+        run: build:default
+        shell: devenv shell -c -- bash -e {0}
+
+      - name: build all features
+        run: build:all
+        shell: devenv shell -c -- bash -e {0}
+
+  security:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: run cargo-deny
+        uses: EmbarkStudios/cargo-deny-action@v2

package/skills/rust-workspace-bootstrap/template/.github/workflows/coverage.yml

@@ -0,0 +1,45 @@
+name: "coverage"
+permissions:
+  contents: read
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  coverage:
+    timeout-minutes: 90
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: generate coverage report
+        run: coverage:all
+        shell: devenv shell -c -- bash -e {0}
+
+      - name: upload lcov artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-lcov
+          path: target/coverage/lcov.info
+          if-no-files-found: error
+
+      - name: upload codecov report
+        uses: codecov/codecov-action@v5
+        with:
+          files: target/coverage/lcov.info
+          fail_ci_if_error: false

package/skills/rust-workspace-bootstrap/template/.github/workflows/docs-pages.yml

@@ -0,0 +1,60 @@
+name: "docs-pages"
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "readme.md"
+      - "devenv.nix"
+      - ".github/workflows/docs-pages.yml"
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    if: github.repository == '__GITHUB_OWNER__/__GITHUB_REPO__'
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: configure github pages
+        uses: actions/configure-pages@v5
+
+      - name: build mdbook docs
+        run: docs:build
+        shell: devenv shell -c -- bash -e {0}
+
+      - name: upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/book
+
+  deploy:
+    if: github.repository == '__GITHUB_OWNER__/__GITHUB_REPO__'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: deploy to github pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/skills/rust-workspace-bootstrap/template/.github/workflows/release-preview.yml

@@ -0,0 +1,52 @@
+name: "release-preview"
+permissions:
+  contents: read
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  preview:
+    timeout-minutes: 20
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: preview release
+        run: |
+          echo "## Release Preview" >> "$GITHUB_STEP_SUMMARY"
+          echo "" >> "$GITHUB_STEP_SUMMARY"
+
+          if ls .changeset/*.md 1>/dev/null 2>&1; then
+            echo "### Changesets" >> "$GITHUB_STEP_SUMMARY"
+            echo '```markdown' >> "$GITHUB_STEP_SUMMARY"
+            for f in .changeset/*.md; do
+              echo "--- $f ---" >> "$GITHUB_STEP_SUMMARY"
+              cat "$f" >> "$GITHUB_STEP_SUMMARY"
+              echo "" >> "$GITHUB_STEP_SUMMARY"
+            done
+            echo '```' >> "$GITHUB_STEP_SUMMARY"
+          else
+            echo "No changesets found in .changeset/." >> "$GITHUB_STEP_SUMMARY"
+          fi
+
+          echo "" >> "$GITHUB_STEP_SUMMARY"
+          echo "### knope release --dry-run" >> "$GITHUB_STEP_SUMMARY"
+          echo '```' >> "$GITHUB_STEP_SUMMARY"
+          knope release --dry-run 2>&1 | tee -a "$GITHUB_STEP_SUMMARY" || true
+          echo '```' >> "$GITHUB_STEP_SUMMARY"
+        shell: devenv shell -- bash -e {0}

package/skills/rust-workspace-bootstrap/template/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: "release"
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Release tag (e.g. v0.3.0). Must start with 'v'."
+        required: true
+        type: string
+
+concurrency:
+  group: ${{ github.workflow }}-${{ inputs.tag || github.event.release.tag_name }}
+  cancel-in-progress: true
+
+jobs:
+  upload_assets:
+    env:
+      CARGO_PROFILE_RELEASE_LTO: true
+      CARGO_PROFILE_RELEASE_CODEGEN_UNITS: 1
+      CARGO_PROFILE_RELEASE_STRIP: symbols
+      RELEASE_TAG: ${{ inputs.tag || github.event.release.tag_name }}
+    permissions:
+      contents: write
+    if: github.repository == '__GITHUB_OWNER__/__GITHUB_REPO__' && startsWith(inputs.tag || github.event.release.tag_name, 'v')
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - target: aarch64-unknown-linux-gnu
+            os: ubuntu-latest
+          - target: aarch64-unknown-linux-musl
+            os: ubuntu-latest
+          - target: aarch64-apple-darwin
+            os: macos-14
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+          - target: x86_64-unknown-linux-musl
+            os: ubuntu-latest
+          - target: x86_64-apple-darwin
+            os: macos-latest
+          - target: x86_64-pc-windows-msvc
+            os: windows-latest
+          - target: aarch64-pc-windows-msvc
+            os: windows-latest
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 60
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.RELEASE_TAG }}
+
+      - name: install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: setup cross toolchain
+        uses: taiki-e/setup-cross-toolchain-action@v1
+        with:
+          target: ${{ matrix.target }}
+        if: startsWith(matrix.os, 'ubuntu') && !contains(matrix.target, '-musl')
+
+      - name: install cross
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cross
+        if: contains(matrix.target, '-musl')
+
+      - name: set static crt linkage
+        shell: bash
+        run: echo "RUSTFLAGS=${RUSTFLAGS} -C target-feature=+crt-static" >> "${GITHUB_ENV}"
+        if: endsWith(matrix.target, 'windows-msvc')
+
+      - name: upload binaries
+        uses: taiki-e/upload-rust-binary-action@v1
+        with:
+          bin: __PROJECT_NAME__
+          manifest-path: crates/__CLI_CRATE__/Cargo.toml
+          package: __CLI_CRATE__
+          ref: refs/tags/${{ env.RELEASE_TAG }}
+          archive: $bin-$target-$tag
+          target: ${{ matrix.target }}
+          tar: all
+          zip: windows
+          token: ${{ secrets.GITHUB_TOKEN }}
+          checksum: sha256,sha512

package/skills/rust-workspace-bootstrap/template/.github/workflows/semver.yml

@@ -0,0 +1,63 @@
+name: "semver"
+permissions:
+  contents: read
+on:
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  semver-checks:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: setup
+        uses: ./.github/actions/devenv
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: run semver-checks
+        id: semver
+        continue-on-error: true
+        run: cargo semver-checks check-release --workspace
+        shell: devenv shell -c -- bash -e {0}
+
+      - name: evaluate semver results
+        if: steps.semver.outcome == 'failure'
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          echo "::warning::semver-checks detected breaking changes"
+
+          title_acknowledged=false
+          if echo "$PR_TITLE" | grep -qE '^[a-zA-Z]+(\(.+\))?!:'; then
+            title_acknowledged=true
+            echo "PR title contains '!' — breaking change acknowledged via title"
+          fi
+
+          changeset_acknowledged=false
+          if ls .changeset/*.md 1>/dev/null 2>&1; then
+            if grep -lE '^[a-zA-Z_]+: major$' .changeset/*.md 1>/dev/null 2>&1; then
+              changeset_acknowledged=true
+              echo "Found major changeset — breaking change acknowledged via changeset"
+            fi
+          fi
+
+          if [ "$title_acknowledged" = true ] || [ "$changeset_acknowledged" = true ]; then
+            echo "::notice::Breaking changes are acknowledged."
+            exit 0
+          fi
+
+          echo "::error::Breaking changes detected but not acknowledged."
+          echo "Add '!' to PR title or create a major changeset via 'knope document-change'."
+          exit 1
+        shell: bash

package/skills/rust-workspace-bootstrap/template/Cargo.toml

@@ -0,0 +1,64 @@
+[workspace]
+resolver = "2"
+members = ["crates/__CORE_CRATE__", "crates/__CLI_CRATE__"]
+
+[workspace.package]
+version = "0.1.0"
+authors = ["__GITHUB_OWNER__"]
+edition = "2024"
+license = "MIT"
+readme = "readme.md"
+repository = "https://github.com/__GITHUB_OWNER__/__GITHUB_REPO__"
+homepage = "https://github.com/__GITHUB_OWNER__/__GITHUB_REPO__"
+rust-version = "1.86.0"
+description = "__DESCRIPTION__"
+
+[workspace.dependencies]
+clap = { default-features = false, version = "^4", features = ["derive", "std"] }
+thiserror = { default-features = false, version = "^2" }
+__CORE_CRATE__ = { path = "crates/__CORE_CRATE__", version = "0.1.0" }
+
+[workspace.metadata.bin]
+cargo-deny = { version = "0.19.0" }
+cargo-llvm-cov = { version = "0.8.4" }
+cargo-nextest = { version = "0.9.129" }
+cargo-semver-checks = { version = "0.46.0" }
+cargo-workspaces = { version = "0.4.2" }
+knope = { version = "0.22.3", bins = ["knope"] }
+
+[workspace.lints.rust]
+rust_2021_compatibility = { level = "warn", priority = -1 }
+rust_2024_compatibility = { level = "warn", priority = -1 }
+unsafe_code = "deny"
+unstable_features = "deny"
+unused_extern_crates = "warn"
+unused_import_braces = "warn"
+unused_lifetimes = "warn"
+unused_macro_rules = "warn"
+unused_qualifications = "warn"
+variant_size_differences = "warn"
+edition_2024_expr_fragment_specifier = "allow"
+
+[workspace.lints.clippy]
+complexity = { level = "warn", priority = -1 }
+correctness = { level = "deny", priority = -1 }
+pedantic = { level = "warn", priority = -1 }
+perf = { level = "warn", priority = -1 }
+style = { level = "warn", priority = -1 }
+suspicious = { level = "warn", priority = -1 }
+
+blocks_in_conditions = "allow"
+cargo_common_metadata = "allow"
+cast_possible_truncation = "allow"
+cast_possible_wrap = "allow"
+cast_precision_loss = "allow"
+cast_sign_loss = "allow"
+items_after_statements = "allow"
+missing_errors_doc = "allow"
+missing_panics_doc = "allow"
+module_name_repetitions = "allow"
+must_use_candidate = "allow"
+no_effect_underscore_binding = "allow"
+too_many_lines = "allow"
+wildcard_dependencies = "deny"
+wildcard_imports = "allow"

package/skills/rust-workspace-bootstrap/template/changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.

package/skills/rust-workspace-bootstrap/template/clippy.toml

@@ -0,0 +1 @@
+msrv = "1.86"

package/skills/rust-workspace-bootstrap/template/crates/__CLI_CRATE__/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "__CLI_CRATE__"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+readme.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+description = "CLI for __PROJECT_NAME__"
+
+[[bin]]
+name = "__PROJECT_NAME__"
+path = "src/main.rs"
+
+[lints]
+workspace = true
+
+[dependencies]
+clap.workspace = true
+__CORE_CRATE__.workspace = true

package/skills/rust-workspace-bootstrap/template/crates/__CLI_CRATE__/src/main.rs

@@ -0,0 +1,21 @@
+use clap::Parser;
+
+#[derive(Debug, Parser)]
+#[command(name = "__PROJECT_NAME__")]
+#[command(about = "__DESCRIPTION__")]
+struct Args {
+	/// Optional name to greet.
+	#[arg(short, long, default_value = "world")]
+	name: String,
+}
+
+fn main() {
+	let args = Args::parse();
+	match __CORE_CRATE__::greet(&args.name) {
+		Ok(message) => println!("{message}"),
+		Err(error) => {
+			eprintln!("error: {error}");
+			std::process::exit(1);
+		}
+	}
+}

package/skills/rust-workspace-bootstrap/template/crates/__CORE_CRATE__/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "__CORE_CRATE__"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+readme.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+description = "Core library for __PROJECT_NAME__"
+
+[lints]
+workspace = true
+
+[dependencies]
+thiserror.workspace = true

package/skills/rust-workspace-bootstrap/template/crates/__CORE_CRATE__/src/lib.rs

@@ -0,0 +1,32 @@
+use thiserror::Error;
+
+#[derive(Debug, Error)]
+pub enum CoreError {
+	#[error("name cannot be empty")]
+	EmptyName,
+}
+
+pub fn greet(name: &str) -> Result<String, CoreError> {
+	if name.trim().is_empty() {
+		return Err(CoreError::EmptyName);
+	}
+
+	Ok(format!("Hello, {name}!"))
+}
+
+#[cfg(test)]
+mod tests {
+	use super::greet;
+
+	#[test]
+	fn greets_with_name() {
+		let result = greet("world");
+		assert_eq!(result.as_deref(), Ok("Hello, world!"));
+	}
+
+	#[test]
+	fn rejects_empty_name() {
+		let result = greet("   ");
+		assert!(result.is_err());
+	}
+}

package/skills/rust-workspace-bootstrap/template/deny.toml

@@ -0,0 +1,18 @@
+[graph]
+all-features = true
+
+[advisories]
+version = 2
+yanked = "deny"
+
+[licenses]
+version = 2
+allow = ["MIT", "Apache-2.0", "BSD-3-Clause", "ISC", "Unicode-3.0"]
+confidence-threshold = 0.93
+
+[bans]
+multiple-versions = "warn"
+
+[sources]
+unknown-registry = "deny"
+unknown-git = "warn"