Merge pull request #17 from tubarao312/example-app

Example app + container publishing

Author: tubarao312

.github/workflows/rust-test.yml

@@ -2,10 +2,14 @@ name: Cargo Build & Test
 
 on:
   push:
+    branches: [ main ]
+    tags: [ 'v*' ]
   pull_request:
 
 env: 
   CARGO_TERM_COLOR: always
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
   build_and_test:
@@ -19,4 +23,35 @@ jobs:
       - uses: actions/checkout@v4
       - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
       - run: cargo build --verbose
-      - run: cargo test --verbose
+      - run: cargo test --verbose
+
+  docker:
+    needs: build_and_test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          
+      - name: Extract metadata for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -0,0 +1,8 @@
+FROM rust:1.75-slim as builder
+WORKDIR /usr/src/app
+COPY . .
+RUN cargo build --release
+
+FROM debian:bookworm-slim
+COPY --from=builder /usr/src/app/target/release/dependency-cascade /usr/local/bin/
+ENTRYPOINT ["dependency-cascade"]

example/README.md

@@ -0,0 +1,24 @@
+# Example Explanation
+This example shows a simple project with three nodes: `example_app`, `example_lib`, and `example_test`.
+
+- `example_app` depends on `example_lib`
+- `example_test` depends on `example_app`
+
+Whenever the contents of `example_app` are changed, `example_test` will show up in `dependency-cascade query`.
+If the contents of `example_lib` are changed, both `example_app` and `example_test` will show up in `dependency-cascade query` because `example_test` depends on `example_app`.
+
+This is a simple example, but in the real world, you might have a more complex project with many dependencies and many tests.
+
+# Pipeline Examples
+
+## Github Actions
+
+## Gitlab Pipeline
+Help wanted!
+
+## Jenkins Pipeline
+Help wanted!
+
+## CircleCI
+Help wanted!
+

example/app/dependencies.toml

@@ -0,0 +1,18 @@
+[module]
+name = "example_app"
+
+[dependencies]
+example_lib = { name = "example_lib" } # Our imaginary app uses the example_lib
+
+[metadata]
+type = "app"
+language = "rust"
+you_can_do_anything_here = "literally anything"
+
+[file_paths]
+include = [
+  "src/**/*"
+]
+exclude = [
+  "README.md"
+]

example/app/src/app_code.txt

@@ -0,0 +1 @@
+Hello world!

example/lib/dependencies.toml

@@ -0,0 +1,17 @@
+[module]
+name = "example_lib"
+
+# Our imaginary library doesn't depent on anything - that's fine.
+
+[metadata]
+type = "lib"
+language = "rust"
+you_can_do_anything_here = "literally anything"
+
+[file_paths]
+include = [
+  "src/**/*"
+]
+exclude = [
+  "README.md"
+]

example/lib/src/lib_code.txt

@@ -0,0 +1 @@
+Hello world!

example/test/dependencies.toml

@@ -0,0 +1,23 @@
+[module]
+name = "example_test"
+
+# Our imaginary test depends on the example_app because that's the only thing we're testing.
+# In the real world, we'd try to check which services the test is meant to touch and make
+# those the dependencies, so that this dependency would show up whenever on of those gets
+# touched.
+
+[dependencies]
+example_app = { name = "example_app" }
+
+[metadata]
+type = "test"
+language = "rust"
+you_can_do_anything_here = "literally anything"
+
+[file_paths]
+include = [
+  "src/**/*"
+]
+exclude = [
+  "README.md"
+]

example/test/src/test_code.txt

@@ -0,0 +1 @@
+Hello world!