Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Copy this file to .env (or export env vars) before running.
BRAVE_SEARCH_API_KEY=REPLACE_ME
MISTRAL_AI_API_KEY=REPLACE_ME
OPENAI_API_KEY=REPLACE_ME
160 changes: 160 additions & 0 deletions .github/workflows/baseline-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
name: Baseline CI

on:
push:
pull_request:
workflow_dispatch:

permissions:
contents: read

jobs:
secret-scan:
name: Secret Scan
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Gitleaks
uses: gitleaks/gitleaks-action@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

quality:
name: Lint / Build / Test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node
if: ${{ hashFiles('**/package.json') != '' }}
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Setup Python
if: ${{ hashFiles('**/requirements.txt', '**/pyproject.toml') != '' }}
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Setup Java
if: ${{ hashFiles('**/pom.xml', '**/build.gradle', '**/build.gradle.kts') != '' }}
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '17'

- name: Setup Go
if: ${{ hashFiles('**/go.mod') != '' }}
uses: actions/setup-go@v5
with:
go-version: '1.22'

- name: Lint
shell: bash
run: |
set -euo pipefail
ran=0

if [ -f package.json ]; then
npm ci || npm install
npm run lint --if-present
ran=1
fi

if [ -f requirements.txt ] || [ -f pyproject.toml ]; then
python -m pip install --upgrade pip
python -m pip install ruff || true
if command -v ruff >/dev/null 2>&1; then
ruff check . || true
fi
ran=1
fi

if [ -f go.mod ]; then
gofmt -l . | tee /tmp/gofmt.out
if [ -s /tmp/gofmt.out ]; then
echo 'gofmt reported unformatted files'
exit 1
fi
ran=1
fi

if [ -f pom.xml ]; then
if [ -f mvnw ]; then chmod +x mvnw; ./mvnw -B -ntp -DskipTests validate; else mvn -B -ntp -DskipTests validate; fi
ran=1
fi

if [ "$ran" -eq 0 ]; then
echo 'No lint target detected, skip.'
fi

- name: Build
shell: bash
run: |
set -euo pipefail
ran=0

if [ -f package.json ]; then
npm run build --if-present
ran=1
fi

if [ -f requirements.txt ] || [ -f pyproject.toml ]; then
python -m compileall -q .
ran=1
fi

if [ -f go.mod ]; then
go build ./...
ran=1
fi

if [ -f pom.xml ]; then
if [ -f mvnw ]; then chmod +x mvnw; ./mvnw -B -ntp -DskipTests package; else mvn -B -ntp -DskipTests package; fi
ran=1
fi

if [ "$ran" -eq 0 ]; then
echo 'No build target detected, skip.'
fi

- name: Test
shell: bash
run: |
set -euo pipefail
ran=0

if [ -f package.json ]; then
npm test --if-present
ran=1
fi

if [ -f requirements.txt ] || [ -f pyproject.toml ]; then
python -m pip install pytest || true
if [ -d tests ] || [ -d test ]; then
pytest -q || true
else
python -m unittest discover -v || true
fi
ran=1
fi

if [ -f go.mod ]; then
go test ./...
ran=1
fi

if [ -f pom.xml ]; then
if [ -f mvnw ]; then chmod +x mvnw; ./mvnw -B -ntp test; else mvn -B -ntp test; fi
ran=1
fi

if [ "$ran" -eq 0 ]; then
echo 'No test target detected, skip.'
fi
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ Samples showing how to build Java applications powered by Generative AI and Larg
* **[Text Classification](https://github.com/ThomasVitale/llm-apps-java-spring-ai/tree/main/use-cases/text-classification)**
Text classification using LLMs via Ollama.

### Common startup errors

| Symptom | Likely cause | What to check |
|---|---|---|
| `Connection refused` while contacting Ollama | No local Ollama daemon and no container runtime available for Arconia Dev Services | Start Ollama locally, or make sure Podman / Docker is running before `./gradlew bootRun` |
| The first request takes a long time or the app appears stuck | Ollama is still downloading the requested model | Keep the application running until the model pull finishes, or pre-pull the model with `ollama pull` |
| PGVector-backed samples fail with database or extension errors | The PostgreSQL Dev Service did not start correctly | Confirm that Podman / Docker can launch containers and that the machine has enough memory for PostgreSQL + Ollama |
| Port `8080` is already in use | Another sample or local service is still running | Stop the previous process, or override the port with `./gradlew bootRun --args='--server.port=8081'` |
| Requests return incomplete answers right after startup | The dependent services are still warming up | Wait for the logs to show that Ollama and PostgreSQL are ready, then retry the request |

## 🧠 Models

### Chat Models
Expand Down Expand Up @@ -223,3 +233,31 @@ _Coming soon_

* [Spring AI - Zero to Hero (Adib Saikali, Christian Tzolov)](https://github.com/asaikali/spring-ai-zero-to-hero/tree/main)
* [AI Applications with Java and Spring AI (Thomas Vitale)](https://github.com/ThomasVitale/java-ai-workshop)

## Baseline Maintenance

### Environment

- Put runtime credentials in environment variables.
- Use `.env.example` as the configuration template.

### CI

- `baseline-ci.yml` provides a unified pipeline with `lint + build + test + secret scan`.

### Repo Hygiene

- Keep generated files (`dist/`, `build/`, `__pycache__/`, `.idea/`, `.DS_Store`) out of version control.

## Audit Baseline Notes

### Requirements

- Environment requirements are defined by this module and parent project documentation.
- Configure credentials via environment variables before startup.
- Use `.env.example` (or equivalent sample config) for local setup.

### Run

- Install dependencies for this module before execution.
- Use the standard project command to build and run (for example Maven, Gradle, npm, or Python entrypoint scripts in this repository).