Skip to content

Commit

Permalink
Update README and cleanup
Browse files Browse the repository at this point in the history
Signed-off-by: Jalander Ramagiri <[email protected]>
  • Loading branch information
Jalander Ramagiri committed May 28, 2024
1 parent e32f8c5 commit 51b3ffc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
5 changes: 3 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ and the [CDEvents Spec repository](https://github.com/cdevents/spec/) is added a
- Steps involved to generate latest SDK
1. Update spec submodule to the latest release
- Create a private working branch from [cdevents/sdk-java](https://github.com/cdevents/sdk-java)
- Checkout the latest spec version and update the submodule from spec root directory
- Update submodule by running `git submodule update --init`
- Checkout the latest release spec version to update the spec repo, from spec root directory
````bash
cd spec
git checkout main && git pull
Expand Down Expand Up @@ -113,7 +114,7 @@ and the [CDEvents Spec repository](https://github.com/cdevents/spec/) is added a
````
- Where, `id`, `sourcePath` needs to be updated with the actual file name and `targetPackage` directory structure needs to be created in [sdk models](./sdk/src/main/java/dev/cdevents/models) for each new schema file if you find in CDEvents Spec schemas

2. Generate CDEvent classes using [mustache template](./generator/src/main/resources/template/event-template.mustache)
3. Generate CDEvent classes using [mustache template](./generator/src/main/resources/template/event-template.mustache)
- [event-template.mustache](./generator/src/main/resources/template/event-template.mustache) needs an update If there is any change in the `context` or `subject` of a CDEvent
- All the [CDEvents](./sdk/src/main/java/dev/cdevents/events) generated by using `event-template.mustache`
- Run `./mvnw verify` and fix if any issues found during the build process
Expand Down
2 changes: 0 additions & 2 deletions generator/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,6 @@
<sourcePath>${parent.project.dir}/spec/schemas/links/embeddedlinkrelation.json</sourcePath>
<sourcePath>${parent.project.dir}/spec/schemas/links/embeddedlinksarray.json</sourcePath>
</sourcePaths>
<!--<sourceDirectory>${parent.project.dir}/spec/schemas/links</sourceDirectory>
<includes>embedded.*\.json</includes>-->
<targetPackage>dev.cdevents.models.links.embedded</targetPackage>
</configuration>
</execution>
Expand Down

0 comments on commit 51b3ffc

Please sign in to comment.