Skip to content

Commit

Permalink
SDK: renaming maven artifacts
Browse files Browse the repository at this point in the history
  • Loading branch information
ivangsa committed Jan 31, 2023
1 parent 135b6ff commit e1007c8
Show file tree
Hide file tree
Showing 156 changed files with 138 additions and 136 deletions.
4 changes: 2 additions & 2 deletions .asyncapi-tool
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: ZenWave Code Generator
description: DDD and API-First for Event-Driven Microservices
links:
websiteUrl: https://zenwave360.github.io/
docsUrl: https://zenwave360.github.io/zenwave-code-generator/plugins/asyncapi-spring-cloud-streams3/
repoUrl: https://github.com/zenwave360/zenwave-code-generator
docsUrl: https://zenwave360.github.io/zenwave-sdk/plugins/asyncapi-spring-cloud-streams3/
repoUrl: https://github.com/zenwave360/zenwave-sdk
filters:
language: Java
technology:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
./plugins/jdl-to-asyncapi/target/site/jacoco/jacoco.csv
./plugins/openapi-spring-webtestclient/target/site/jacoco/jacoco.csv
./plugins/openapi-rest-assured/target/site/jacoco/jacoco.csv
./zenwave-code-generator-cli/target/site/jacoco/jacoco.csv
./zenwave-sdk-cli/target/site/jacoco/jacoco.csv
- name: Log coverage percentage
run: |
Expand Down Expand Up @@ -86,11 +86,11 @@ jobs:
- name: Comment on PR with coverage percentages
if: ${{ github.event_name == 'pull_request' }}
run: |
REPORT=$(<badges/zenwave-code-generator-cli/coverage-summary.json)
REPORT=$(<badges/zenwave-sdk-cli/coverage-summary.json)
COVERAGE=$(jq -r '.coverage' <<< "$REPORT")%
BRANCHES=$(jq -r '.branches' <<< "$REPORT")%
NEWLINE=$'\n'
BODY="## JaCoCo Test Coverage Summary Statistics (zenwave-code-generator-cli)${NEWLINE}* __Coverage:__ ${COVERAGE}${NEWLINE}* __Branches:__ ${BRANCHES}"
BODY="## JaCoCo Test Coverage Summary Statistics (zenwave-sdk-cli)${NEWLINE}* __Coverage:__ ${COVERAGE}${NEWLINE}* __Branches:__ ${BRANCHES}"
gh pr comment ${{github.event.pull_request.number}} -b "${BODY}"
continue-on-error: true
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-maven-central.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
./plugins/jdl-to-openapi/target/site/jacoco/jacoco.csv
./plugins/jdl-to-asyncapi/target/site/jacoco/jacoco.csv
./plugins/openapi-spring-webtestclient/target/site/jacoco/jacoco.csv
./zenwave-code-generator-cli/target/site/jacoco/jacoco.csv
./zenwave-sdk-cli/target/site/jacoco/jacoco.csv
- name: Log coverage percentage
run: |
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ ZenWave Code Generator features two complementary contributing models:

## Plugins as a Bazaar

One of the main promises of ZenWave Code Generator is to provide a plugin system that allows developers to easily extend and personalize the core functionality of the tool, create entirely new plugins or [fork existing ones](https://github.com/ZenWave360/zenwave-code-generator#forking-an-standard-or-custom-plugin).
One of the main promises of ZenWave Code Generator is to provide a plugin system that allows developers to easily extend and personalize the core functionality of the tool, create entirely new plugins or [fork existing ones](https://github.com/ZenWave360/zenwave-sdk#forking-an-standard-or-custom-plugin).

Plugins as packed as standard java jar files and installed on any local, corporate or public maven repo and can be added to jbang or maven classpath as a dependency.

You don't need to ask permission, become a code developer, request write access to this repo or even create pull requests to create your own plugins:

- Just find a plugin that you want to extend or fork
- This [fork command](https://github.com/ZenWave360/zenwave-code-generator#forking-an-standard-or-custom-plugin) will download current source code from GitHub, find the plugin you want to fork and will create a new project with the forked source code, performing some basic replacements in java packages names and maven groupId/artifactId
- This [fork command](https://github.com/ZenWave360/zenwave-sdk#forking-an-standard-or-custom-plugin) will download current source code from GitHub, find the plugin you want to fork and will create a new project with the forked source code, performing some basic replacements in java packages names and maven groupId/artifactId
- Do your modifications and install your plugin to any maven repo. Both JBang and Maven will be able to find your plugin as a dependency using your maven settings. You don't even need to publish your changes.
- If you think your changes are worth considering to be merged back to the original plugin. Open an issue following this process, and we will be happy to review your changes and start a discussion:
- Create a GitHub repo with a base project and use your plugin to generate on top of it.
Expand All @@ -37,4 +37,4 @@ We love your input! We want to make contributing to this project as easy and tra
Happy contributing :heart:

## License
When you submit changes, your submissions are understood to be under the same [MIT](https://github.com/ZenWave360/zenwave-code-generator/blob/main/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
When you submit changes, your submissions are understood to be under the same [MIT](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

> 👉 ZenWave360 Helps You Create Software that's Easy to Understand
[![Maven Central](https://img.shields.io/maven-central/v/io.github.zenwave360.zenwave-code-generator/zenwave-code-generator.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.github.zenwave360.zenwave-code-generator/zenwave-code-generator)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZenWave360/zenwave-code-generator?logo=GitHub)](https://github.com/ZenWave360/zenwave-code-generator/releases)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.zenwave360.zenwave-sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.github.zenwave360.zenwave-sdk/zenwave-sdk)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZenWave360/zenwave-sdk?logo=GitHub)](https://github.com/ZenWave360/zenwave-sdk/releases)
![General Availability](https://img.shields.io/badge/lifecycle-GA-green)
[![build](https://github.com/ZenWave360/zenwave-code-generator/workflows/build/badge.svg)](https://github.com/ZenWave360/zenwave-code-generator/actions/workflows/build.yml)
[![coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-code-generator/badges/jacoco.svg)](https://github.com/ZenWave360/zenwave-code-generator/actions/workflows/build.yml)
[![branches coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-code-generator/badges/branches.svg)](https://github.com/ZenWave360/zenwave-code-generator/actions/workflows/build.yml)
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-code-generator)](https://github.com/ZenWave360/zenwave-code-generator/blob/main/LICENSE)
[![build](https://github.com/ZenWave360/zenwave-sdk/workflows/build/badge.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/badges/jacoco.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![branches coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/badges/branches.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)

ZenWave Code Generator is a configurable and extensible code generator tool for **Domain Driven Design (DDD)** and **API-First** that can generate code from a mix of different models including:

Expand All @@ -23,27 +23,27 @@ ZenWave Code Generator is a configurable and extensible code generator tool for

**Table of Contents:**

- [ZenWave Code Generator](#zenwave-code-generator)
- [ZenWave Code Generator](#zenwave-sdk)
- [Jbang Instalation](#jbang-instalation)
- [Features / Roadmap](#features--roadmap)
- [Building from source](#building-from-source)
- [Usage](#usage)
- [Available Plugins](#available-plugins)
- [Forking an Standard or Custom Plugin](#forking-an-standard-or-custom-plugin)
- [ZenWave Code Generator Documentation](#zenwave-code-generator-documentation)
- [ZenWave Code Generator Documentation](#zenwave-sdk-documentation)

## Jbang Instalation

The easiest way to install ZenWave Code Generator is as a [JBang alias](https://www.jbang.dev/documentation/guide/latest/alias_catalogs.html):

```shell
jbang alias add --fresh --name=zw release@zenwave360/zenwave-code-generator
jbang alias add --fresh --name=zw release@zenwave360/zenwave-sdk
```

or if you prefer to use the latest **snapshot** versions:

```shell
jbang alias add --fresh --name=zw zw-snapshots@zenwave360/zenwave-code-generator
jbang alias add --fresh --name=zw zw-snapshots@zenwave360/zenwave-sdk
```

If you plan to use **custom plugins** you will need to use the command in the following format:
Expand All @@ -54,15 +54,15 @@ jbang alias add --name=zw \
--repos=mavencentral,snapshots=https://s01.oss.sonatype.org/content/repositories/snapshots \
--deps=\
org.slf4j:slf4j-simple:1.7.36,\
io.github.zenwave360.zenwave-code-generator.plugins:asyncapi-spring-cloud-streams3:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:asyncapi-jsonschema2pojo:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:openapi-spring-webtestclient:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:openapi-rest-assured:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:jdl-backend-application-default:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:jdl-to-openapi:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:jdl-to-asyncapi:1.0.0.RC1,\
io.github.zenwave360.zenwave-code-generator.plugins:jdl-openapi-controllers:1.0.0.RC1 \
io.github.zenwave360.zenwave-code-generator:zenwave-code-generator-cli:1.0.0.RC1
io.github.zenwave360.zenwave-sdk.plugins:asyncapi-spring-cloud-streams3:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:asyncapi-jsonschema2pojo:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:openapi-spring-webtestclient:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:openapi-rest-assured:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:jdl-backend-application-default:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:jdl-to-openapi:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:jdl-to-asyncapi:1.0.0.RC1,\
io.github.zenwave360.zenwave-sdk.plugins:jdl-openapi-controllers:1.0.0.RC1 \
io.github.zenwave360.zenwave-sdk:zenwave-sdk-cli:1.0.0.RC1
```

You can include any **custom plugin** jars in the `--deps` option.
Expand Down Expand Up @@ -129,8 +129,8 @@ JBang will use you maven settings for repository resolution, but you can also sp
## Building from source

```shell
git clone https://github.com/ZenWave360/zenwave-code-generator.git
cd zenwave-code-generator
git clone https://github.com/ZenWave360/zenwave-sdk.git
cd zenwave-sdk
mvn clean install
```

Expand Down Expand Up @@ -204,7 +204,7 @@ jbang zw -p io.zenwave360.generator.plugins.ForkPlugin -h
| `targetFolder` | | String | | |
| `sourcePluginClassName` | Plugin Plugin class to fork | String | | |
| `targetPluginClassName` | New Plugin Plugin class. It will be used for class name, package and maven groupId. | String | | |
| `downloadURL` | Download URL for the source code of original plugin in zip format | URL | https://github.com/ZenWave360/zenwave-code-generator/archive/refs/tags/v1.0.0.RC1.zip | |
| `downloadURL` | Download URL for the source code of original plugin in zip format | URL | https://github.com/ZenWave360/zenwave-sdk/archive/refs/tags/v1.0.0.RC1.zip | |

Example:

Expand All @@ -221,4 +221,4 @@ Now you can add this jar to the list of available plugins in [jbang install comm

# ZenWave Code Generator Documentation

Please refer to the [documentation](https://zenwave360.github.io/zenwave-code-generator/) website for more information.
Please refer to the [documentation](https://zenwave360.github.io/zenwave-sdk/) website for more information.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ search_enabled: true
logo: "https://raw.githubusercontent.com/ZenWave360/.github/main/logos/code-generator/code-generator-logo-right-side-text.svg"
aux_links:
"See on GitHub":
- "//github.com/zenwave360/zenwave-code-generator"
- "//github.com/zenwave360/zenwave-sdk"
ga_tracking: G-PWPE0ZF877
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)

Expand Down
2 changes: 1 addition & 1 deletion docs/online.food.delivey-ddd.md.back
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ We will use **OpenAPI**, **AsyncAPI** and other specs to define the communicatio

### Access data owned by other bounded contexts: Direct Access, Event Sourcing and CQRS

- **Direct Access:** [Generates a full OpenAPI definitions for CRUD operations from JDL models](https://zenwave360.github.io/zenwave-code-generator/plugins/jdl-to-openapi/)
- **Direct Access:** [Generates a full OpenAPI definitions for CRUD operations from JDL models](https://zenwave360.github.io/zenwave-sdk/plugins/jdl-to-openapi/)
- **Event Sourcing:** _TODO_
- from entities.jdl (aggregates)
- generate AsyncAPI definition and SpringData event listeners with SpringCloudStreams client that writes event to a topic
Expand Down
28 changes: 14 additions & 14 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

> 👉 ZenWave360 Helps You Create Software that's Easy to Understand
[![Maven Central](https://img.shields.io/maven-central/v/io.github.zenwave360.zenwave-code-generator/zenwave-code-generator.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.github.zenwave360.zenwave-code-generator/zenwave-code-generator)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZenWave360/zenwave-code-generator?logo=GitHub)](https://github.com/ZenWave360/zenwave-code-generator/releases)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.zenwave360.zenwave-sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.github.zenwave360.zenwave-sdk/zenwave-sdk)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ZenWave360/zenwave-sdk?logo=GitHub)](https://github.com/ZenWave360/zenwave-sdk/releases)
![General Availability](https://img.shields.io/badge/lifecycle-GA-green)
[![build](https://github.com/ZenWave360/zenwave-code-generator/workflows/build/badge.svg)](https://github.com/ZenWave360/zenwave-code-generator/actions/workflows/build.yml)
[![coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-code-generator/badges/jacoco.svg)](https://github.com/ZenWave360/zenwave-code-generator/actions/workflows/build.yml)
[![branches coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-code-generator/badges/branches.svg)](https://github.com/ZenWave360/zenwave-code-generator/actions/workflows/build.yml)
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-code-generator)](https://github.com/ZenWave360/zenwave-code-generator/blob/main/LICENSE)
[![build](https://github.com/ZenWave360/zenwave-sdk/workflows/build/badge.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/badges/jacoco.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![branches coverage](https://raw.githubusercontent.com/ZenWave360/zenwave-sdk/badges/branches.svg)](https://github.com/ZenWave360/zenwave-sdk/actions/workflows/build.yml)
[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)

## Domain Driven Design (DDD) and API-First for Event Driven Microservices

Expand All @@ -26,15 +26,15 @@ Using JHipster Domain Language as **Ubiquitous Language** for **Data on the Insi
- **API-First specs like AsyncAPI and OpenAPI:** to describe Inter Process Communications (IPC) between bounded contexts/microservices.
- **ZenWave Code Generator:** to generate (_a lot of_) infrastructure, functional and testing code from your models and APIs.

ZenWave Code Generator is designed to be easily extensible and adaptable to your project or your organization needs and likes. You can always [fork an existing, standard or custom plugin](https://github.com/ZenWave360/zenwave-code-generator/#forking-an-standard-or-custom-plugin).
ZenWave Code Generator is designed to be easily extensible and adaptable to your project or your organization needs and likes. You can always [fork an existing, standard or custom plugin](https://github.com/ZenWave360/zenwave-sdk/#forking-an-standard-or-custom-plugin).

You can install the latest release using [jbang](https://www.jbang.dev) running the following command:

```shell
jbang alias add --fresh --name=zw release@zenwave360/zenwave-code-generator
jbang alias add --fresh --name=zw release@zenwave360/zenwave-sdk
```

Please refer to [**ZenWave Code Generator**](https://github.com/ZenWave360/zenwave-code-generator/) for more detailed installation options.
Please refer to [**ZenWave Code Generator**](https://github.com/ZenWave360/zenwave-sdk/) for more detailed installation options.

**Note:** Official plugins are designed to generate functional code and tests on top of existing projects. Creating a base project is out of scope, but you can always go to [start.spring.io](http://start.spring.io) or [start.jhipster.tech](https://start.jhipster.tech/), in case your company doesn't already have a project starter or archetype.

Expand Down Expand Up @@ -62,7 +62,7 @@ In this way all team members: **Domain Experts**, **Product Owners**, **Software
## Table of Contents

<!-- TOC -->
- [ZenWave Code Generator](#zenwave-code-generator)
- [ZenWave Code Generator](#zenwave-sdk)
- [Domain Driven Design (DDD) and API-First for Event Driven Microservices](#domain-driven-design-ddd-and-api-first-for-event-driven-microservices)
- [Not (just) a Code Generator](#not-just-a-code-generator)
- [Why Domain Driven Design?](#why-domain-driven-design)
Expand Down Expand Up @@ -355,8 +355,8 @@ jbang zw -p io.zenwave360.generator.plugins.JDLToAsyncAPIPlugin \

```xml
<plugin>
<groupId>io.github.zenwave360.zenwave-code-generator</groupId>
<artifactId>zenwave-code-generator-maven-plugin</artifactId>
<groupId>io.github.zenwave360.zenwave-sdk</groupId>
<artifactId>zenwave-sdk-maven-plugin</artifactId>
<version>${zenwave.version}</version>
<plugin>
<skip>false</skip>
Expand All @@ -368,12 +368,12 @@ jbang zw -p io.zenwave360.generator.plugins.JDLToAsyncAPIPlugin \
</executions>
<dependencies>
<dependency><!-- Plugins standard or custom go here -->
<groupId>io.github.zenwave360.zenwave-code-generator.plugins</groupId>
<groupId>io.github.zenwave360.zenwave-sdk.plugins</groupId>
<artifactId>asyncapi-spring-cloud-streams3</artifactId>
<version>${zenwave.version}</version>
</dependency>
<dependency>
<groupId>io.github.zenwave360.zenwave-code-generator.plugins</groupId>
<groupId>io.github.zenwave360.zenwave-sdk.plugins</groupId>
<artifactId>asyncapi-jsonschema2pojo</artifactId>
<version>${zenwave.version}</version>
</dependency>
Expand Down
Loading

0 comments on commit e1007c8

Please sign in to comment.