https://github.com/espressif/gh-esp-test-template

ESP Project Testing Template (CI Project Template/Demo)
https://github.com/espressif/gh-esp-test-template

Last synced: 2 days ago
JSON representation

ESP Project Testing Template (CI Project Template/Demo)

• Host: GitHub
• URL: https://github.com/espressif/gh-esp-test-template
• Owner: espressif
• License: cc0-1.0
• Created: 2022-06-21T11:13:46.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T11:59:30.000Z (about 1 month ago)
• Last Synced: 2024-09-18T16:00:22.326Z (8 days ago)
• Language: C
• Size: 2.65 MB
• Stars: 11
• Watchers: 8
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ESP-IDF Project Template with CI, Wokwi Simulation, and Hardware Testing

This is a template project to be used as a reference for ESP-IDF projects with GitHub CI.

![GitHub Workflow Status](https://github.com/wokwi/wokwi-esp-test-template/actions/workflows/ci_workflow.yml/badge.svg)

The purpose of this project is to provide a good **starting point for customers who are developing an application based on Espressif chips and want to run unit or integration tests both in simulation and on real hardware.**

*You can fork and update this project according to your specific needs.*

> Note: As default, the hardware testing job is `disabled`. To enable it, please see the **How to setup (HW)** documents.

## How to setup (Wokwi simulation)

Go to the [Wokwi CI Dashboard](https://wokwi.com/ci/dashboard) and create a new CI token. Then add the token to your GitHub repository secrets as `WOKWI_CLI_TOKEN` (under "Settings" -> "Secrets and Variables" -> "Actions" -> "Repository secrets").

You can also run the tests locally. For more information, please refer to the [Wokwi CI documentation](https://docs.wokwi.com/wokwi-ci/getting-started).

## How to setup (HW)

- [GitHub Action Workflow](docs/ghub_action_workflow.md)

- [GitHub Runner Setup](docs/ghub_runner_setup.md)

## License

The content of this repository is released into the public domain, or [CC0 licensed](LICENSE), at your option.