This repository serves as a template for new EDC repositories.
It can also be used by adopters that want to build their dataspace component based on the EDC.
Select "Use this template > Create a new repository". See the GitHub guide for details.
The default workflows require the following secrets:
| Secret | Workflow(s) | Comment |
|---|---|---|
DISCORD_WEBHOOK_GITHUB |
discord-webhook.yml | webhook URL of Discord channel |
GITHUB_TOKEN |
first-interaction.yml, scan-pull-request.yml, stale-bot.yml | usually already set |
ORGANIZATION_PROJECT |
add-to-project.yml | already set for EDC org |
Update (at least) the following files:
- README
- line 28 in NOTICE
- lines 2, 5-7, and 10-11 in gradle.properties
- lines 2, 11, and 15 in settings.gradle.kts
- lines 2 and 11 in build.gradle.kts
- gradle/libs.versions.toml
- lines 28 and 30 in version-catalog/build.gradle.kts
- CODEOWNERS
Fill or delete:
- core: Contains all absolutely essential building that is necessary to run the component.
- extensions: This contains code that extends the component's core functionality with technology-specific code.
- launchers: Launchers are essentially EDC packages that are runnable, e.g., gradle buildfile, Dockerfile
- spi: This is the primary extension point for the code. It contains all necessary interfaces that need to be implemented
as well as essential model classes and enums. Basically, the
spimodules defines the extent to what users can customize and extend the code. - system-tests: The system tests verify the end-to-end deployment of a component. They can be run locally (using Docker, Kubernetes) or in a pipeline.
Developer documentation can be found under docs/developer, where the main concepts and decisions are captured as decision records.
See how to contribute for details.