search

rogeruiz / scuttle

An automation translation layer for working with Structurizr DSL
https://github.com/rogeruiz/scuttle/issues/9
GNU Affero General Public License v3.0
24 stars 6 forks source link

The branches in this repository are confusing #9

Open rogeruiz opened 2 years ago

rogeruiz commented 2 years ago

The main branch in this repository holds the new Rust-based Scuttle CLI tool to generate C4 model diagrams from already written code.

The scuttle-dos branch is poorly named, but it contains a series of Make targets that helps folks build C4 model diagrams from scratch. Eventually, the main branch will have this functionality when Scuttle is released as a 2.0 version. But for now, if you're working on DSL file in Structurizr and what an easy workflow, use the scuttle-dos branch as it's a proof of concept.

The master branch is the legacy branch that contains the original code for Scuttle 1.0. This will stick around indefinitely as the future iterations will always be considered "orphaned branches" as they are complete rewrites of the original intention of Scuttle.

Any other branches here will be prefixed by a GitHub user, myself for now, to house the diagrams that are being worked on. This are created from the scuttle-dos branch until eventually they will be created from the main branch possible. This repository can be used to help sell folks on the idea of C4 model diagrams and have a workspace that can still be collaborative due to Git.

Eventually, this documentation will exist somewhere besides this issue, but I figured it would be helpful for folks stumbling on to this. There will be more information on how to create new branches in order to be able to work on either the development of the CLI or just generally use the automation that was built around Structurizr using the scuttle-dos branch.

rogeruiz commented 2 years ago

hat tip to @gidjin to remind me that branches in this repository are confusing.