From 14bf25f4f69040dba1c3dc62443c857174b1498e Mon Sep 17 00:00:00 2001 From: Elia Maggioni Date: Fri, 25 Nov 2022 12:57:59 +0100 Subject: [PATCH 1/3] test --- src/main.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main.rs b/src/main.rs index 5b02151..598e3b6 100644 --- a/src/main.rs +++ b/src/main.rs @@ -3,4 +3,7 @@ fn main() { "The answer to the ultimate question is {}", rust_template::answer() ); + println!( + "What do you get when you multiply six by nine" + ); } From 4ead9a852352aeb8288c1e16fb4789bdc060f4b3 Mon Sep 17 00:00:00 2001 From: Elia Maggioni Date: Fri, 25 Nov 2022 13:04:12 +0100 Subject: [PATCH 2/3] fmt --- src/main.rs | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/main.rs b/src/main.rs index 598e3b6..fca9983 100644 --- a/src/main.rs +++ b/src/main.rs @@ -3,7 +3,5 @@ fn main() { "The answer to the ultimate question is {}", rust_template::answer() ); - println!( - "What do you get when you multiply six by nine" - ); + println!("What do you get when you multiply six by nine"); } From 29a584f5b3cafe1531724e94f24f4537efe7e489 Mon Sep 17 00:00:00 2001 From: Elia Maggioni Date: Mon, 28 Nov 2022 10:26:36 +0100 Subject: [PATCH 3/3] readme --- README.md | 100 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 58 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index d62c3cd..9204f2c 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,64 @@ -# Title of the projects +# Rust Repository Template [![CI](https://github.com/runtime-machines/rust-template/workflows/CI/badge.svg)](https://github.com/runtime-machines/rust-template/actions) -## Description and scope of the project - -Use this repository as a production ready starting point for developing bug-free, well formatted, rust projects :) - -### What does this repository do: - -Workflows: - -- CI Workflows: - - Test - - Format check - - Clippy - - Docs - - Publish - - Code coverage report on PR - -- CD Workflows: \ - Release artifacts on Cargo and Github for: - - os: macos-latest - target: x86_64-apple-darwin - - os: ubuntu-latest - target: x86_64-unknown-linux-gnu - - os: windows-latest - target: x86_64-pc-windows-msvc - - os: ubuntu-latest - target: aarch64-unknown-linux-gnu - - os: ubuntu-latest - target: i686-unknown-linux-gnu - -- Security: - - Audit everyday at 00.00 UTC - - dependabot to update dependencies weekly - -Templates: -- Issue Templates -- Pull Request Template - -## Installation - -Click the "Use this template" button in the repo mainpage\ -Change "rust-template" with your repository name everywhere +⭐ `Star` this repository if you find it valuable and worth maintaining. + +👁 `Watch` this repository to get notified about new releases, issues, etc. + +## Description + +This is a GitHub repository template for a Go application. +You can use it: + +- to create a new repoisitory with automation and environment setup, +- as reference when improving automation for an existing repository. + +It includes: + +- continuous integration via [GitHub Actions](https://github.com/features/actions) + - CI Workflows: + - Test + - Format check + - Clippy + - Docs + - Publish + - Code coverage report on PR + - CD Workflows (Release artifacts on Cargo and Github): + - os: macos-latest + target: x86_64-apple-darwin + - os: ubuntu-latest + target: x86_64-unknown-linux-gnu + - os: windows-latest + target: x86_64-pc-windows-msvc + - os: ubuntu-latest + target: aarch64-unknown-linux-gnu + - os: ubuntu-latest + target: i686-unknown-linux-gnu + - Security: + - Audit everyday at 00.00 UTC + - dependabot to update dependencies weekly +- build automation via [Cargo](https://doc.rust-lang.org/cargo/commands/cargo-build.html), +- dependency management using [Cargo Modules](https://doc.rust-lang.org/book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html), +- code formatting using [rust fmt](https://rust-lang.github.io/rustfmt/), +- linting with [clippy](https://github.com/rust-lang/rust-clippy), +- code coverage [HTML report](https://docs.codecov.com/docs) and tests +- releasing using [Github Release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) and [Cargo publish](https://doc.rust-lang.org/cargo/commands/cargo-publish.html), +- dependencies scanning and updating thanks to [Dependabot](https://dependabot.com), +- security code analysis using [Audit-check](https://github.com/actions-rs/audit-check), + + +## Usage + +1. Sign up on [Codecov](https://codecov.io/) and configure + [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories. +1. Click the `Use this template` button (alt. clone or download this repository). +1. Replace all occurrences of `runtime-machines/rust-template` to `your_org/repo_name` in all files. +1. Update the following files: + - [CHANGELOG.md](CHANGELOG.md) + - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) + - [LICENSE](LICENSE) (when defined) + - [README.md](README.md) ## License