Skip to content

Commit

Permalink
Add example of working with Git submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
Fredrik10a committed Nov 5, 2024
1 parent e929099 commit 06e3f10
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
Binary file added usage-examples/submodule-git.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions usage-examples/submodules-eiffel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Working with GIT submodules
This example discusses how one could build the relational tree structure representing submodules within GIT using Eiffel events.

## Introduction
A common use case in GIT is where one want to connect a relationship between repositories to be able to mirror the GIT structure as it is. The scenario could be that you have a parent repository who have one or many GIT submodule.

Below is a simple image of how it could look in GIT.

![alt text](./submodule-git.png)

## Eiffel solution
This will show you one setup for the Eiffel model on how to get around the use-case where there is a sceanrio where GIT submodules are used.

![alt text](./submodules-eiffel.png)

Depending on the solution setup, a Service can be created to listen for SCCs (Source Change Created) that carry a specific identification tag/id for the Parent repository. Upon detecting such an SCC, the Service uses the SourceChange API to read the SHA IDs of contained submodules. It then fetches the related SCCs based on these IDs. Finally, it generates a CompositionDefined (CD) event and publishes it on the bus.

Important drawback from this is that it does not create a linear relationship downwards. Even though one could argue that it does, but it requires knowledge about what SCC one is suposed to query.
Binary file added usage-examples/submodules-eiffel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 06e3f10

Please sign in to comment.