[DRAFT] Add example of working with Git submodules #404
Conversation
There was a problem hiding this comment.
Thank you for the contribution and glad to have you onboard!
Could I ask you fill in the PR template with some text and put your signature in the form of name and email? You don't need to be very lengthy but some explanation on what the update was. I would probably have added the following:
### Applicable Issues
Task from the [October 2024 community meeting](https://hackmd.io/e5x-6vRGSnio02m8snhn0A) to capture the discussion on how a submodule setup could look like.
### Description of the Change
Added a page describing how to model submodules using Eiffel events.
### Alternate Designs
Not Applicable
### Possible Drawbacks
Nothing that I can think ofIt could be that you only wanted to create a draft PR https://github.blog/news-insights/product-news/introducing-draft-pull-requests/ . In that case we don't require you to fill in the PR template just to get the discussion started.
If you got any question please don't hesitate to ask or reach out to me. No question is too stupid.
|
|
||
| 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. |
There was a problem hiding this comment.
I noticed that I had to approve the pipeline start. The linting failed with
usage-examples/submodules-eiffel.md:18:196 MD047/single-trailing-newline Files should end with a single newline character
|
|
||
|  | ||
|
|
||
| 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. |
There was a problem hiding this comment.
I had some problems following how this could look like. Could you add the link names in the picture?
Fredrik10a
changed the title
Applicable Issues
Description of the Change
Alternate Designs
Possible Drawbacks
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: