https://github.com/eclipse-score/module_template
C++ & Rust Bazel Template Repository
https://github.com/eclipse-score/module_template
Last synced: 3 months ago
JSON representation
C++ & Rust Bazel Template Repository
- Host: GitHub
- URL: https://github.com/eclipse-score/module_template
- Owner: eclipse-score
- License: apache-2.0
- Created: 2025-03-09T17:10:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-31T08:59:44.000Z (3 months ago)
- Last Synced: 2026-03-31T10:31:14.663Z (3 months ago)
- Language: Starlark
- Homepage: https://eclipse-score.github.io/module_template
- Size: 3.82 MB
- Stars: 2
- Watchers: 8
- Forks: 15
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Notice: NOTICE
Awesome Lists containing this project
README
# C++ & Rust Bazel Template Repository
This repository serves as a **template** for setting up **C++ and Rust projects** using **Bazel**.
It provides a **standardized project structure**, ensuring best practices for:
- **Build configuration** with Bazel.
- **Testing** (Component and Feature Integration Tests).
- **Documentation** setup.
- **CI/CD workflows**.
- **Development environment** configuration.
---
## 📂 Project Structure
| File/Folder | Description |
| ----------------------------------- | ------------------------------------------------- |
| `README.md` | Short description & build instructions |
| `src/` | Source files and Unit Tests for the module |
| `tests/` | Component and Feature Integration Tests (CIT&FIT) |
| `examples/` | Example files used for guidance |
| `docs/` | Documentation (Doxygen for C++ / mdBook for Rust) |
| `.github/workflows/` | CI/CD pipelines |
| `.vscode/` | Recommended VS Code settings |
| `.bazelrc`, `MODULE.bazel`, `BUILD` | Bazel configuration & settings |
| `project_config.bzl` | Project-specific metadata for Bazel macros |
| `LICENSE.md` | Licensing information |
| `CONTRIBUTION.md` | Contribution guidelines |
---
## 🚀 Getting Started
### 1️⃣ Clone the Repository
```sh
git clone https://github.com/eclipse-score/YOUR_PROJECT.git
cd YOUR_PROJECT
```
### 2️⃣ Build the Examples of module
> DISCLAIMER: Depending what module implements, it's possible that different
> configuration flags needs to be set on command line.
To build all targets of the module the following command can be used:
```sh
bazel build //src/...
```
This command will instruct Bazel to build all targets that are under Bazel
package `src/`. The ideal solution is to provide single target that builds
artifacts, for example:
```sh
bazel build //src/:release_artifacts
```
where `:release_artifacts` is filegroup target that collects all release
artifacts of the module.
> NOTE: This is just proposal, the final decision is on module maintainer how
> the module code needs to be built.
### 3️⃣ Run Tests
All tests:
```sh
bazel test //...
```
Unit tests:
```sh
bazel test //src/...
```
Component / Feature integration tests:
```sh
bazel test //tests/...
```
---
## 🛠 Tools & Linters
The template integrates **tools and linters** from **centralized repositories** to ensure consistency across projects.
- **C++:** `clang-tidy`, `cppcheck`, `Google Test`
- **Rust:** `clippy`, `rustfmt`, `Rust Unit Tests`
- **CI/CD:** GitHub Actions for automated builds and tests
---
## 📖 Documentation
- A **centralized docs structure** is planned.
---
## ⚙️ `project_config.bzl`
This file defines project-specific metadata used by Bazel macros, such as `dash_license_checker`.
### 📌 Purpose
It provides structured configuration that helps determine behavior such as:
- Source language type (used to determine license check file format)
- Safety level or other compliance info (e.g. ASIL level)
### 📄 Example Content
```python
PROJECT_CONFIG = {
"asil_level": "QM", # or "ASIL-A", "ASIL-B", etc.
"source_code": ["cpp", "rust"] # Languages used in the module
}
```
### 🔧 Use Case
When used with macros like `dash_license_checker`, it allows dynamic selection of file types
(e.g., `cargo`, `requirements`) based on the languages declared in `source_code`.