Skip to content

Commit b28c1fb

Browse files
Update documentation for team registration and template usage
1 parent eccc26e commit b28c1fb

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

CLAUDE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ GitHub template repository for creating new services on the Javabin platform.
88
|------|---------|
99
| `app.yaml` | Platform service configuration — compute, routing, resources, auth |
1010
| `Dockerfile` | Multi-stage build (Java/Temurin by default, adapt for your runtime) |
11+
| `.github/workflows/deploy.yml` | CI entrypoint — calls `javabin.yml` reusable workflow |
1112
| `README.md` | Starter README with getting-started steps |
1213

1314
## How to Use
1415

1516
1. Click **"Use this template"** on GitHub to create a new repo under `javaBin/`
1617
2. Edit `app.yaml` — set your service name, team, compute settings, routing, and any resources
17-
3. Register your app by opening a PR to [javaBin/registry](https://github.com/javaBin/registry) with `apps/{name}.yaml`
18+
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
1819
4. Push to `main` — the platform CI builds, plans, reviews, and deploys automatically
1920

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

3738
## CI
3839

39-
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.
40+
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.
4041

4142
## Related
4243

4344
- [javaBin/platform](https://github.com/javaBin/platform) — shared infrastructure and reusable modules
44-
- [javaBin/registry](https://github.com/javaBin/registry)app and team registration
45-
- [javaBin/javabin-cli](https://github.com/javaBin/javabin-cli)`javabin register` automates registration
45+
- [javaBin/registry](https://github.com/javaBin/registry) — team registration
46+
- [javaBin/javabin-cli](https://github.com/javaBin/javabin-cli)`javabin register` automates team registration

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A Javabin platform service.
55
## Getting Started
66

77
1. **Create from template**: Click "Use this template" on GitHub
8-
2. **Register your app**: Open a PR to [javaBin/registry](https://github.com/javaBin/registry) adding `apps/your-service.yaml`
8+
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
99
3. **Customize `app.yaml`**: Set your service name, team, compute, and routing
1010
4. **Push to main**: The platform CI pipeline builds, plans, reviews, and deploys automatically
1111

0 commit comments

Comments
 (0)