Skip to content
Merged
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
54 changes: 54 additions & 0 deletions .github/workflows/backend.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Backend CI

on:
push:
branches:
- main
paths:
- 'sticker-business/**'
- '.github/workflows/backend.yml'
pull_request:
paths:
- 'sticker-business/**'
- '.github/workflows/backend.yml'

permissions:
contents: read

jobs:
backend:
name: Backend build and tests
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Set up Java
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 25
cache: maven

- name: Build and test
run: ./mvnw -B clean verify
working-directory: sticker-business

database:
name: Database
runs-on: ubuntu-latest
services:
mysql:
image: mysql:8.4
env:
MYSQL_ROOT_PASSWORD: ci-root-password
MYSQL_DATABASE: sticker_business
options: >-
--health-cmd="mysqladmin ping --host=127.0.0.1 --user=root --password=ci-root-password"
--health-interval=10s
--health-timeout=5s
--health-retries=10
--health-start-period=30s
steps:
- name: Confirm MySQL is healthy
run: echo "MySQL 8.4 is ready."

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Building the database is a good idea within the CI. The echo statement will always succeed and this creates false confidence in the state of the database, since nothing can actually fail it.
This is fine for now since this PR introduces CI when our application is still a skeleton. Once we have actual database work being performed by our application, we should add tests that run our code against a real MySQL database, so CI verifies our schema and queries work.

47 changes: 47 additions & 0 deletions .github/workflows/frontend.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Frontend CI

on:
push:
branches:
- main
paths:
- 'frontend/**'
- '.github/workflows/frontend.yml'
pull_request:
paths:
- 'frontend/**'
- '.github/workflows/frontend.yml'

permissions:
contents: read

jobs:
frontend:
name: Frontend build and checks
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 24
cache: npm
cache-dependency-path: frontend/package-lock.json

- name: Install dependencies
run: npm ci
working-directory: frontend

- name: Test
run: npm test
working-directory: frontend

- name: Lint
run: npm run lint
working-directory: frontend

- name: Build and type-check
run: npm run build
working-directory: frontend
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ An open source framework that helps anyone start their own sticker-printing micr
- [What you need to install](#what-you-need-to-install)
- [Running the application](#running-the-application)
- [Everyday development](#everyday-development)
- [Continuous integration](#continuous-integration)
- [Troubleshooting](#troubleshooting)
- [Team standards](#team-standards)
- [Acknowledgments](#acknowledgments)
Expand Down Expand Up @@ -108,6 +109,12 @@ docker compose up --build

**Line endings:** the repo's root `.gitattributes` file converts checked out files to your operating system's native ending when you check out.

### Continuous integration
GitHub Actions runs checks on pull requests and merges to main:
- **Frontend** ([frontend.yml](.github/workflows/frontend.yml)): `npm ci`, `npm test`, `npm run lint`, and `npm run build` (which includes the TypeScript checks).
- **Backend** ([backend.yml](.github/workflows/backend.yml)): `./mvnw -B clean verify`, which builds the application, runs its tests, and checks Java formatting; a separate job starts MySQL 8.4 and waits for its health check to pass.


## Troubleshooting
| Problem | Cause and fix |
|---|---|
Expand Down
Loading
Loading