add examples

Author: markovejnovic

examples/README.md

@@ -0,0 +1,34 @@
+# Harmont examples
+
+Minimal idiomatic starter projects, each wired up to a Harmont CI pipeline. Every example lives in its own subdirectory with a `.harmont/pipeline.py` you can read, copy, and run via `hm run <slug> --local`.
+
+| Example | Toolchain | Pipeline |
+|---|---|---|
+| [react](./react) | npm + Vite + Vitest + ESLint | `hm.npm(...)` |
+| [nextjs](./nextjs) | npm + Jest + ESLint | `hm.npm(...)` |
+| [typescript](./typescript) | tsc + Vitest + ESLint | `hm.npm(...)` |
+| [rust](./rust) | cargo + clippy + rustfmt | `hm.rust(...)` |
+| [haskell](./haskell) | cabal + hlint + fourmolu | `hm.haskell(ghc="9.6.7")` |
+| [python-uv](./python-uv) | uv + pytest + ruff + mypy | `hm.python(...)` |
+| [go](./go) | go build/test/vet/fmt | `hm.go(...)` |
+| [java](./java) | Gradle + JUnit 5 | `hm.gradle(jdk="21")` |
+| [kotlin](./kotlin) | Gradle + kotlin.test | `hm.gradle(jdk="21", kotlin=True)` |
+| [c](./c) | CMake + CTest + clang-format | `hm.cmake(lang="c")` |
+| [cpp](./cpp) | CMake + CTest + clang-format | `hm.cmake(lang="cpp")` |
+| [csharp](./csharp) | dotnet + xunit + dotnet-format | `hm.dotnet(channel="8.0")` |
+| [ruby](./ruby) | Bundler + RSpec + Rubocop | `hm.ruby(...)` |
+| [perl](./perl) | cpanm + Test::More + Perl::Critic | `hm.perl(...)` |
+| [php-laravel](./php-laravel) | Composer + Laravel test + PHPStan | `hm.composer(laravel=True)` |
+| [ocaml](./ocaml) | opam + Dune + Alcotest | `hm.ocaml(compiler="5.1.1")` |
+| [zig](./zig) | zig build/test/fmt | `hm.zig(version="0.13.0")` |
+
+## How to run an example locally
+
+1. Install the Harmont CLI (`cli/` in this repo, or `cargo install harmont-cli` once published).
+2. `cd examples/<lang>` and run `hm run ci --local`. The CLI uses the project's `.harmont/pipeline.py` and executes each step in a local Docker container, sharing caches across runs.
+
+Every pipeline uses `default_image="ubuntu:24.04"` and the apt-base / language-install steps are cached forever — only the action leaves (`test`, `lint`, etc.) re-run after a code change.
+
+## What to copy
+
+The shape every pipeline shares: a single `@hm.target()` builds the toolchain object once; the `@hm.pipeline("ci")` body returns a tuple of leaves (`build`, `test`, `lint`). Each leaf forks off the shared install step, so adding a fifth check costs you the action — never the install.

examples/c/.harmont/pipeline.py

@@ -0,0 +1,19 @@
+"""C example pipeline."""
+from __future__ import annotations
+
+import harmont as hm
+
+
+@hm.pipeline(
+    "ci",
+    env={"CI": "true"},
+    default_image="ubuntu:24.04",
+    triggers=[hm.push(branch="main")],
+)
+def ci() -> tuple[hm.Step, ...]:
+    project = hm.cmake(path=".", lang="c")
+    return (
+        project.build(),
+        project.test(),
+        project.fmt(),
+    )

examples/c/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.20)
+project(harmont_example_c C)
+set(CMAKE_C_STANDARD 11)
+
+add_library(addlib src/main.c)
+
+enable_testing()
+add_executable(test_main tests/test_main.c)
+target_link_libraries(test_main PRIVATE addlib)
+add_test(NAME test_main COMMAND test_main)

examples/c/README.md

@@ -0,0 +1,12 @@
+# C example
+
+CMake + CTest hello-add C library. Pipeline runs cmake configure + build + ctest + clang-format check.
+
+## Run the pipeline
+
+```sh
+cd examples/c
+hm run ci --local
+```
+
+See `.harmont/pipeline.py` for the definition; `examples/README.md` for the full index.

examples/c/src/main.c

@@ -0,0 +1,5 @@
+#include "main.h"
+
+int add(int a, int b) {
+    return a + b;
+}

examples/c/src/main.h

@@ -0,0 +1,2 @@
+#pragma once
+int add(int a, int b);

examples/c/tests/test_main.c

@@ -0,0 +1,5 @@
+#include "../src/main.h"
+
+int main(void) {
+    return add(2, 3) == 5 ? 0 : 1;
+}

examples/cpp/.harmont/pipeline.py

@@ -0,0 +1,19 @@
+"""C++ example pipeline."""
+from __future__ import annotations
+
+import harmont as hm
+
+
+@hm.pipeline(
+    "ci",
+    env={"CI": "true"},
+    default_image="ubuntu:24.04",
+    triggers=[hm.push(branch="main")],
+)
+def ci() -> tuple[hm.Step, ...]:
+    project = hm.cmake(path=".", lang="cpp")
+    return (
+        project.build(),
+        project.test(),
+        project.fmt(),
+    )

examples/cpp/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.20)
+project(harmont_example_cpp CXX)
+set(CMAKE_CXX_STANDARD 20)
+
+add_library(addlib src/main.cpp)
+
+enable_testing()
+add_executable(test_main tests/test_main.cpp)
+target_link_libraries(test_main PRIVATE addlib)
+add_test(NAME test_main COMMAND test_main)

examples/cpp/README.md

@@ -0,0 +1,12 @@
+# C++ example
+
+CMake + CTest hello-add C++ library. Pipeline uses `hm.cmake(lang="cpp")` to label steps `:cpp:` and runs configure + build + ctest + clang-format check.
+
+## Run the pipeline
+
+```sh
+cd examples/cpp
+hm run ci --local
+```
+
+See `.harmont/pipeline.py` for the definition; `examples/README.md` for the full index.