Skip to content

Commit

Permalink
Merge pull request #15 from OSGP/feature/readme
Browse files Browse the repository at this point in the history
Updated readme with per-template configuration
  • Loading branch information
sanderv authored Nov 4, 2024
2 parents 53297a8 + f810f57 commit c53f5da
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# GXF Service template
This is a template repository for GXF services.

## Developer configuration
## Per-template configuration
1. Add `gxf-developers` as admin to the contributors
2. Setup branch protection with the following flags
- Require a pull request before merging
- Require approvals (1 or 2 depending on the type of repository)
- Dismiss stale pull request approvals when new commits are pushed
- Do not allow bypassing the above settings
2. Add Backstage meta-data
3. Change the name `gxf-service-template` to your component name in
- `build.gradle.kts`: `imageName.set("ghcr.io/osgp/gxf-service-template:${version}")`
- `settings.gradle.kts`: `rootProject.name = "gxf-service-template"`

## Developer environment configuration (only once)
To retrieve GXF dependencies you need to configure a local GitHub token.

1. Go to GitHub to create a classic token: [Create Classic Token](https://github.com/settings/tokens/new)
Expand Down

0 comments on commit c53f5da

Please sign in to comment.