Log ingest

This repo is created with cargo generate --git https://github.com/skanehira/rust-cli-template (start with cargo install cargo-generate )

Overview

This repository serves as a template for quickly bootstrapping Rust command-line interface (CLI) applications using cargo-generate. It provides a minimal yet comprehensive foundation with the following features:

• CLI argument parsing using clap with derive macros
• GitHub Actions workflow for CI/CD
  • Code coverage reporting with octocov
  • Automatic benchmark result visualization and deployment with github-action-benchmark
  • Security audit checks for dependencies
  • Automated release workflow for publishing
  • Automated dependency updates with Dependabot

Project Structure

Generated projects will have the following structure:

.
├── .github/           # GitHub Actions workflows
│   ├── workflows/     # CI/CD workflows for testing, benchmarking, and releasing
│   │   ├── ci.yml     # Main CI workflow (tests, linting, coverage)
│   │   ├── audit.yml  # Security audit workflow
│   │   └── release.yml # Release automation workflow
│   └── dependabot.yaml # Automated dependency update configuration file
├── benches/           # Benchmark code (requires nightly Rust)
├── src/               # Source code
├── .gitignore         # Git ignore file
├── .octocov.yml       # Code coverage configuration
├── goreleasser.yaml   # GoReleaser configuration file for cross-platform builds and distribution
├── Cargo.toml         # Project manifest
├── Cargo.lock         # Dependency lock file
└── rust-toolchain.toml # Rust toolchain configuration

Benchmark visualization

The benchmark results are automatically deployed to GitHub Pages for easy visualization and performance tracking. You need to create a gh-pages branch in your repository before first push.

Coverage

This project uses octocov to measure code coverage. During CI execution, coverage reports are automatically generated and displayed as comments on PRs or commits. The coverage history is also tracked, allowing you to see changes over time.

The coverage reports are deployed to GitHub Pages for easy visualization. Coverage information can also be displayed in the README as a badge.

The detailed configuration for octocov is managed in the .octocov.yml file.

Usage

Prerequisites

• cargo-generate
• gh

Creating a New Project

Create a new project using this template:

cargo generate --git https://github.com/skanehira/rust-cli-template.git

Follow the prompts to customize your project.

Running Tests

cargo test

Running Benchmarks

Benchmarks require the nightly Rust channel:

cargo +nightly bench

Release Process

This template includes an automated release workflow. Follow these steps to create a release:

1. Push a tag with your changes:

   git tag v0.1.0  # Replace with the appropriate version number
   git push origin v0.1.0
   

2. When the tag is pushed, the GitHub Actions release.yml workflow will automatically execute. This workflow:

   • Builds cross-platform binaries (Linux, macOS, Windows)
   • Creates a GitHub Release
   • Uploads binaries and changelog

The release configuration is managed in the .github/workflows/release.yml and goreleasser.yaml files.

---

Feel free to customize this template to fit your specific needs!