https://github.com/shishir-dey/stm32-devops-template

Repository for showcasing DevOps practices within microcontroller projects
https://github.com/shishir-dey/stm32-devops-template

ci-cd cmake devcontainers devops embedded-systems github-codespaces stm32

Last synced: 10 months ago
JSON representation

Repository for showcasing DevOps practices within microcontroller projects

• Host: GitHub
• URL: https://github.com/shishir-dey/stm32-devops-template
• Owner: shishir-dey
• License: mit
• Created: 2022-10-27T03:49:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-06-20T05:32:18.000Z (10 months ago)
• Last Synced: 2025-06-20T06:20:07.595Z (10 months ago)
• Topics: ci-cd, cmake, devcontainers, devops, embedded-systems, github-codespaces, stm32
• Language: C
• Homepage: https://shishir-dey.github.io/stm32-devops-template/
• Size: 5.22 MB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# STM32 DevOps Template

Repository for showcasing DevOps practices within microcontroller projects.

## Overview

The STM32 DevOps Template is a comprehensive embedded systems project that demonstrates modern DevOps practices applied to microcontroller development. This template showcases efficient data structures, automated testing, and continuous integration/deployment pipelines specifically designed for STM32 microcontrollers.

## Build Status

[![CMake](https://github.com/shishir-dey/stm32-devops-template/actions/workflows/cmake.yml/badge.svg)](https://github.com/shishir-dey/stm32-devops-template/actions/workflows/cmake.yml)

[![Generate Sphinx documentation](https://github.com/shishir-dey/stm32-devops-template/actions/workflows/sphinx.yml/badge.svg)](https://github.com/shishir-dey/stm32-devops-template/actions/workflows/sphinx.yml)

[![Pages Build & Deployment](https://github.com/shishir-dey/stm32-devops-template/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/shishir-dey/stm32-devops-template/actions/workflows/pages/pages-build-deployment)

## Quick Start

### Building for Host (Testing)

```bash

mkdir build && cd build

cmake -DHOST=ON ..

make

ctest

```

### Building for STM32 Target

```bash

mkdir build && cd build

cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/arm-none-eabi-gcc.cmake ..

make

```

### Generating Documentation

```bash

cd docs

pip install -r requirements.txt

make html

```

## Project Structure

```

stm32-devops-template/

├── src/                    # Source code

│   ├── data/              # Data structure implementations

│   ├── main.c             # Main application

│   └── autogen/           # Generated files (startup, linker)

├── test/                   # Unity unit tests

├── lib/Unity/             # Unity testing framework

├── docs/                   # Sphinx documentation

├── cmake/                  # CMake toolchain and modules

├── config/                 # Project configuration

└── .github/workflows/      # CI/CD pipelines

```

## Documentation

📖 **[Full Documentation](https://shishir-dey.github.io/stm32-devops-template/)**

The complete documentation includes:

- API Reference with Sphinx + Breathe

- Usage Examples and Best Practices

- Testing Framework Guide

- DevOps Integration Instructions