Giter Club home page Giter Club logo

sebastienfi / structurizr-gen-images Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 1.0 25 KB

This GitHub Action automatically generates and updates Structurizr diagrams on pull requests. It's designed to simplify the process of keeping architecture diagrams up-to-date with the latest changes in your codebase.

Home Page: https://github.com/sebastienfi/structurizr-github-actions-demo

License: MIT License

c4 c4-model documentation-as-code generator git github-actions graphviz plantuml structurizr structurizr-cli

structurizr-gen-images's People

Contributors

sebastienfi avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

mystichar

structurizr-gen-images's Issues

[FEATURE REQUEST] Not just work on pull request!

Feature Summary

Make it so it doesnt error out on push requests!

Detailed Description

When I attempted to change the on pull request to on push, the references broke.

Run git config --global user.name github-actions
  git config --global user.name github-actions
  git config --global user.email [email protected]
  git commit -m "chores(C4 diagrams): Update Structurizr diagrams"
  git push origin HEAD:${GITHUB_HEAD_REF}
  shell: bash --noprofile --norc -e -o pipefail {0}
  env:
    GIT_REF: dev
    CHANGES_EXIST: true
    GITHUB_TOKEN: ***
[dev 036b5c8] chores(C4 diagrams): Update Structurizr diagrams
 6 files changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 .documentation/diagrams/structurizr-Component-001-key.png
 create mode 100644 .documentation/diagrams/structurizr-Component-001.png
 create mode 100644 .documentation/diagrams/structurizr-Component-002-key.png
 create mode 100644 .documentation/diagrams/structurizr-Component-002.png
 create mode 100644 .documentation/diagrams/structurizr-SystemContext-001-key.png
 create mode 100644 .documentation/diagrams/structurizr-SystemContext-001.png
fatal: invalid refspec 'HEAD:'```

### Motivation and Benefits

It allows the image to be more versitilely used and integrated into more complex workflows.versatilely

### Possible Implementation

Easiest solution would seem to be to move all the commit/push code to the workflow instead of the image.

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct

[FEATURE REQUEST] SVG Export Support

Feature Summary

Add support for SVG export.

Detailed Description

Add the capability to export SVGs from the container.

Motivation and Benefits

This would just add another usefull alternative to the blocky PNGs for integration into GitHub wiki's.

Possible Implementation

Add a modifiable env variable to the workflow to allow for SVG export instead of PNGs.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.