Skip to content

Update documentation for template usage #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alexanderamiri merged 1 commit into from
Mar 10, 2026
Merged

Update documentation for template usage #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ GitHub template repository for creating new services on the Javabin platform.
|------|---------|
| `app.yaml` | Platform service configuration — compute, routing, resources, auth |
| `Dockerfile` | Multi-stage build (Java/Temurin by default, adapt for your runtime) |
| `.github/workflows/deploy.yml` | CI entrypoint — calls `javabin.yml` reusable workflow |
| `README.md` | Starter README with getting-started steps |

## How to Use

1. Click **"Use this template"** on GitHub to create a new repo under `javaBin/`
2. Edit `app.yaml` — set your service name, team, compute settings, routing, and any resources
3. Register your app by opening a PR to [javaBin/registry](https://github.com/javaBin/registry) with `apps/{name}.yaml`
3. Ensure your team is registered in [javaBin/registry](https://github.com/javaBin/registry) (`teams/{name}.yaml`) and add the repo to your GitHub team
4. Push to `main` — the platform CI builds, plans, reviews, and deploys automatically

## app.yaml Fields
Expand All @@ -36,10 +37,10 @@ The default Dockerfile uses `eclipse-temurin:21` for a Java/Maven project. Repla

## CI

This template does not include a workflow file. The platform's reusable workflow is called from `javaBin/platform/.github/workflows/javabin.yml`. Your repo just needs to be registered — CI is automatic.
This template includes `.github/workflows/deploy.yml` which calls the platform's reusable workflow `javaBin/platform/.github/workflows/javabin.yml@main`. No additional workflow config needed.

## Related

- [javaBin/platform](https://github.com/javaBin/platform) — shared infrastructure and reusable modules
- [javaBin/registry](https://github.com/javaBin/registry) — app and team registration
- [javaBin/javabin-cli](https://github.com/javaBin/javabin-cli) — `javabin register` automates registration
- [javaBin/registry](https://github.com/javaBin/registry) — team registration
- [javaBin/javabin-cli](https://github.com/javaBin/javabin-cli) — `javabin register` automates team registration
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A Javabin platform service.
## Getting Started

1. **Create from template**: Click "Use this template" on GitHub
2. **Register your app**: Open a PR to [javaBin/registry](https://github.com/javaBin/registry) adding `apps/your-service.yaml`
2. **Register your team**: If not already registered, open a PR to [javaBin/registry](https://github.com/javaBin/registry) adding `teams/your-team.yaml`, then add this repo to your GitHub team
3. **Customize `app.yaml`**: Set your service name, team, compute, and routing
4. **Push to main**: The platform CI pipeline builds, plans, reviews, and deploys automatically

Expand Down