Skip to content
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

Add shortcut script to generate diagrams locally #21

Merged
merged 2 commits into from
Jul 6, 2020
Merged

Conversation

sldblog
Copy link
Contributor

@sldblog sldblog commented Jul 3, 2020

What does this pull request do?

Adds script/generate_images.sh to generate images like


structurizr-54669-system-overview


structurizr-55246-nomiscontainer


structurizr-55246-prisonerContentHubContainerProductionDeployment


It requires

  • structurizr CLI, this will be auto-downloaded
  • plantuml, this has to be pre-installed (it's on brew)

The goal is to make it super easy to generate images locally without having to push to Structurizr.

They look reasonably nice too.

What is the intent behind these changes?

To enable us to view the results of our changes without pushing to the Structurizr API, resulting in (hopefully) easier workflow.

Usage: `script/generate_images.sh`

It requires
- structurizr CLI, this will be auto-downloaded
- plantuml, this has to be pre-installed (it's on `brew`)

The goal is to make it super easy to generate images locally without
having to push to Structurizr.

They look reasonably nice too.
@sldblog sldblog requested a review from a team as a code owner July 3, 2020 14:07
Copy link
Contributor

@garethmdavies garethmdavies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved - will be really useful to see these diagrams locally prior to pushing.

@sldblog sldblog merged commit b37a0d7 into main Jul 6, 2020
@sldblog sldblog deleted the generate-images branch July 6, 2020 10:23
@sldblog
Copy link
Contributor Author

sldblog commented Jul 6, 2020

🎩 🙇‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants