-
Notifications
You must be signed in to change notification settings - Fork 243
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use puml to generate sources diagrams #482
Draft
slawekjaranowski
wants to merge
2
commits into
master
Choose a base branch
from
sources-with-puml
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| */ | ||
| @startuml | ||
| !pragma layout smetana | ||
|
|
||
| skinparam rectangle { | ||
| BackgroundColor LightBlue | ||
| } | ||
|
|
||
| package "Maven Core" { | ||
| rectangle Maven | ||
| rectangle "Core ITs" | ||
| rectangle Resolver | ||
| rectangle "Ant Tasks" | ||
| } | ||
|
|
||
| 'hidden dependencies to change layout | ||
| Maven -[hidden]right-> "Core ITs" | ||
| "Core ITs" -[hidden]right-> Resolver | ||
| Resolver -[hidden]right-> "Ant Tasks" | ||
|
|
||
| url of Maven is [[https://github.com/apache/maven]] | ||
| url of "Core ITs" is [[https://github.com/apache/maven-integration-testing]] | ||
| url of Resolver is [[https://github.com/apache/maven-resolver]] | ||
| url of "Ant Tasks" is [[https://github.com/maven-resolver-ant-tasks]] | ||
|
|
||
| @enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| */ | ||
| @startuml | ||
| !pragma layout smetana | ||
|
|
||
| skinparam rectangle { | ||
| BackgroundColor LightBlue | ||
| } | ||
|
|
||
| package "Maven Doxia" { | ||
| rectangle Doxia | ||
| rectangle "Site Tools" | ||
| rectangle Site #LightGrey | ||
| package Tools { | ||
| rectangle Converter | ||
| rectangle LinkCheck | ||
| } | ||
| } | ||
|
|
||
| 'hidden dependencies to change layout | ||
| Doxia -[hidden]right-> "Site Tools" | ||
| "Site Tools" -[hidden]right-> Site | ||
| "Site Tools" -[hidden]right-> Tools | ||
|
|
||
| 'url of "Ant Tasks" is [[https://github.com/maven-resolver-ant-tasks]] | ||
|
|
||
| @enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| */ | ||
| @startuml | ||
| !pragma layout smetana | ||
|
|
||
| skinparam rectangle { | ||
| BackgroundColor LightBlue | ||
| } | ||
|
|
||
| package Misc { | ||
| rectangle Archetypes | ||
| rectangle Poms | ||
| rectangle Skins | ||
| rectangle Studies | ||
| rectangle Indexer | ||
| rectangle Wagon | ||
| rectangle "Plugin testing" | ||
| rectangle "dist-tool" | ||
| package Jenkins { | ||
| rectangle env | ||
| rectangle lib | ||
| } | ||
| } | ||
|
|
||
| 'hidden dependencies to change layout | ||
| Archetypes -[hidden]right-> Poms | ||
| Poms -[hidden]right-> Skins | ||
| Skins -[hidden]right-> Studies | ||
| Studies -[hidden]right-> Indexer | ||
| Indexer -[hidden]right-> Wagon | ||
| Wagon -[hidden]right-> "Plugin testing" | ||
|
|
||
| Archetypes -[hidden]down-> "dist-tool" | ||
| "dist-tool" -[hidden]right-> Jenkins | ||
|
|
||
| 'url of "Ant Tasks" is [[https://github.com/maven-resolver-ant-tasks]] | ||
|
|
||
| @enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| */ | ||
| @startuml | ||
| !pragma layout smetana | ||
|
|
||
| skinparam rectangle { | ||
| BackgroundColor LightBlue | ||
| } | ||
|
|
||
|
|
||
| package Plugins { | ||
|
|
||
| package Core { | ||
| rectangle clean | ||
| rectangle compiler | ||
| rectangle deploy | ||
| rectangle install | ||
| rectangle resources | ||
| rectangle site | ||
| rectangle surefire | ||
| rectangle verifier | ||
| } | ||
|
|
||
| package Packaging { | ||
| rectangle ear | ||
| rectangle ejb | ||
| rectangle jar | ||
| rectangle rar | ||
| rectangle war | ||
| rectangle acr | ||
| rectangle shade | ||
| rectangle source | ||
| rectangle jlink | ||
| rectangle jmod | ||
| } | ||
|
|
||
| package Reporting { | ||
| rectangle changelog | ||
| rectangle changes | ||
| rectangle checkstyle | ||
| rectangle doap | ||
| rectangle javadoc | ||
| rectangle jdeps | ||
| rectangle jxr | ||
| rectangle linkcheck | ||
| rectangle pmd | ||
| rectangle "project-info-reports" | ||
| } | ||
|
|
||
| package Tools { | ||
| rectangle antrun | ||
| rectangle archetype | ||
| rectangle assembly | ||
| rectangle dependency | ||
| rectangle enforcer | ||
| rectangle gpg | ||
| rectangle help | ||
| rectangle invoker | ||
| rectangle jarsigner | ||
| rectangle jdeprscan | ||
| rectangle patch | ||
| rectangle pdf | ||
| rectangle plugin | ||
| rectangle release | ||
| rectangle "remote-resource" | ||
| rectangle scm | ||
| rectangle "scm-publish" | ||
| rectangle scripting | ||
| rectangle stage | ||
| rectangle toolchains | ||
| } | ||
| } | ||
|
|
||
| 'hidden dependencies to change layout | ||
| Core -[hidden]-> Packaging | ||
| Packaging -[hidden]-> Reporting | ||
| Reporting -[hidden]-> Tools | ||
|
|
||
| clean -[hidden]> compiler | ||
| compiler -[hidden]> deploy | ||
| deploy -[hidden]> install | ||
| install -[hidden]> resources | ||
| resources -[hidden]> site | ||
| site -[hidden]> surefire | ||
| surefire -[hidden]> verifier | ||
|
|
||
| ear -[hidden]> ejb | ||
| ejb -[hidden]> jar | ||
| jar -[hidden]> rar | ||
| rar -[hidden]> war | ||
| war -[hidden]> acr | ||
| acr -[hidden]> shade | ||
| shade -[hidden]> source | ||
| source -[hidden]> jlink | ||
| jlink -[hidden]> jmod | ||
|
|
||
|
|
||
| url of clean is [[https://github.com/apache/maven-clean-plugin]] | ||
|
|
||
| @enduml | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| */ | ||
| @startuml | ||
| !pragma layout smetana | ||
|
|
||
| rectangle Site | ||
| rectangle Sources #LightBlue | ||
|
|
||
| url of Site is [[https://github.com/apache/maven-site]] | ||
| url of Sources is [[https://github.com/apache/maven-sources]] | ||
|
|
||
| @enduml |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My PlantUML knowledge is a bit rusty... Is there a difference between
-[hidden]->(as above) and-[hidden]>(here)?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also learn by testing ...https://plantuml.com/component-diagram
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the same page:
How would you feel about using that notation? I feel it might be friendlier to those who aren't so familiar with PlantUML and wish to make changes to this diagram.