Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rfprod/rust-workspace

Rust workspace with workflow automation.
https://github.com/rfprod/rust-workspace

github-actions-ci rust-workspace workflow-automation

Last synced: about 1 month ago
JSON representation

Rust workspace with workflow automation.

Host: GitHub
URL: https://github.com/rfprod/rust-workspace
Owner: rfprod
License: mit
Created: 2022-05-01T07:48:17.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-06-11T06:13:41.000Z (7 months ago)
Last Synced: 2024-06-11T07:32:21.487Z (7 months ago)
Topics: github-actions-ci, rust-workspace, workflow-automation
Language: Rust
Homepage: https://rfprod.github.io/rust-workspace/
Size: 325 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md

Awesome Lists containing this project

README

        # Rust workspace

Rust workspace with workflow automation.

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Workflows

|                                                                              | Trigger                             | Badge                                                                                                                                                                                                      |

| ---------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| [:information_source:](# 'Full testing, deliverables build and deployment.') | PR merge event (destination: trunk) | [![trunk](https://github.com/rfprod/rust-workspace/actions/workflows/trunk.yml/badge.svg)](https://github.com/rfprod/rust-workspace/actions/workflows/trunk.yml)                                           |

| [:information_source:](# 'Code ownership validation.')                       | Scheduled (weekly)                  | [![validate-codeowners](https://github.com/rfprod/rust-workspace/actions/workflows/validate-codeowners.yml/badge.svg)](https://github.com/rfprod/rust-workspace/actions/workflows/validate-codeowners.yml) |

| [:information_source:](# 'Quality gates: pull request validation.')          | PR open event (destination: trunk)  | [![validate-pr](https://github.com/rfprod/rust-workspace/actions/workflows/validate-pr.yml/badge.svg)](https://github.com/rfprod/rust-workspace/actions/workflows/validate-pr.yml)                         |

## Requirements

In order to run own copy of the project one must fulfill the following requirements.

### Supported operating systems

- :trophy: [Debian based Linux](https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based)

  - install all dependencies required to work with the project except NodeJS: rustup, commitizen, shellcheck

    ```bash

    bash tools/shell/install.sh all

    ```

  - see help for available options

    ```bash

    bash tools/shell/install.sh ?

    ```

- :ok: [OSX](https://en.wikipedia.org/wiki/MacOS)

  - install all dependencies required to work with the project except Python: rustup, commitizen, shellcheck

    ```bash

    bash tools/shell/install.sh all osx

    ```

  - see help for available options

    ```bash

    bash tools/shell/install.sh ?

    ```

- 🤷 [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows)

  - install shellcheck

    ```powershell

    iwr -useb get.scoop.sh | iex

    scoop install shellcheck

    ```

  - recommended shell: [Git for Windows](https://gitforwindows.org/) > `Git BASH`

  - configure Git to use LF as a carriage return

    ```bash

    git config --global core.autocrlf false

    git config --global core.eol lf

    ```

  - one will have to figure out oneself how to install the `commitizen` package, the instructions for Linux will possibly work (see below)

### Integrated development environment

:trophy: [Visual Studio Code](https://code.visualstudio.com/) - recommended for all operating systems

### Core dependencies

- [Bash 5](https://www.gnu.org/software/bash/)

- [Python 3.6+](https://www.python.org/) - `for OSX to use the global commitizen installation`

- [NodeJS](https://nodejs.org/) - `for Linux to use the global commitizen installation`

- [Git](https://git-scm.com/)

- [Rust](https://www.rust-lang.org/)

## Committing changes to the repo

### Linux

Using [commitizen cli](https://github.com/commitizen/cz-cli) is mandatory.

The commit message are validated during the premerge checks.

It is assumed that [Node.js](https://nodejs.org/) is installed.

Given the [NodeJS](https://nodejs.org/) is installed, and [commitizen cli is installed as a global dependency](https://github.com/commitizen/cz-cli#conventional-commit-messages-as-a-global-utility), the following command should be used to initiate the commit process

```bash

git cz

```

Alternatively, given there are no conflicts with other projects that use [the commitizen npm package](https://www.npmjs.com/package/commitizen), one could install commitizen globally via `pypi` like this

```bash

sudo pip3 install -U Commitizen

```

### OSX

Using [commitizen](https://pypi.org/project/commitizen/) is mandatory.

The commit message are validated during the premerge checks.

After installing the package as a global utility using the following command

```bash

brew install commitizen

```

one can use one of the following commands to initiate the commit process

```bash

cz commit

```

or

```bash

cz c

```

## General Tooling

This project was generated using [Cargo](https://doc.rust-lang.org/cargo/).



The Rust and Cargo logos (bitmap and vector) are owned by the Rust Foundation and distributed under the terms of the Creative Commons Attribution license (CC-BY). The logos are used in compliance with the Rust Foundation Logo Policy and Media Guide. No changes have been made to the original logos used by the project. The project was created for educational purposes.

### What is Cargo

**Cargo is the [Rust](https://www.rust-lang.org/) [package manager](https://doc.rust-lang.org/cargo/appendix/glossary.html#package-manager). Cargo downloads your Rust [package's](https://doc.rust-lang.org/cargo/appendix/glossary.html#package) dependencies, compiles your packages, makes distributable packages, and uploads them to [crates.io](https://crates.io/), the Rust community [package registry](https://doc.rust-lang.org/cargo/appendix/glossary.html#package-registry).**

### Quick Start & Documentation

- [The Rust language documentation](https://www.rust-lang.org/tools/install)

### Further help

```bash

rustup --help

```

```bash

cargo --help

```

## Technology Reference

### Workspace

- [rustup](https://rust-lang.github.io/rustup/)

- [Rust](https://doc.rust-lang.org/book/)

- [Cargo](https://doc.rust-lang.org/cargo)

### CI

- [GitHub Actions](https://github.com/features/actions)

### Development methodology

- [Trunk based development](https://trunkbaseddevelopment.com/)