Dependency graph

This document contains information that is supplementary to the README.md file in each of the custom GitHub action projects maintained by fish-shop.

Cross-project dependencies

The diagram below indicates dependencies between fish-shop actions and some external dependencies. A solid line indicates an explicit dependency (i.e. one declared and satisfied directly within the action file itself) and a dotted line represents an implicit dependency (i.e. those not directly satisfied by an action but which must be satisfied in a workflow for the action to function correctly).

The only external dependency required by all but one of the actions maintained by fish-shop is fish shell. This can be installed in a workflow step using the fish-shop/install-fish-shell action.

graph LR
    classDef action stroke:#00f
    classDef external stroke:#bada55

    id1(install-fish-shell)
    id2(install-plugin)
    id3(install-plugin-manager)
    id4(syntax-check)
    id5(run-fishtape-tests)
    id6(indent-check)

    id2:::action & id3:::action & id4:::action & id5:::action & id6:::action -.-> fish:::external
    id1:::action 

    id2 --> id3
    id5 --> id2

Loading

Note

Command dependencies have been omitted for brevity. For example, fish-shop/install-fish-shell requires bash and brew when running on a macOS-based runner and bash, sudo, apt-add-repository, and apt-get when running on ubuntu-based runners. Such dependencies are satisfied by GitHub-hosted runners and are therefore not included in the diagram above. 🚀