jpipe-mcscert/jPipe Runner

GitHub Action to run justification diagrams of jpipe

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
jd_filePath to the justification .jd.json fileyes
variableDefine one or more variables in the format NAME:VALUE, separated by newlinesno
config-filePath to the configuration file for jPipe Runner (yaml)no
librarySpecify one or more Python libraries to load, separated by newlinesyes
diagramSpecify diagram pattern or wildcardno*
formatOutput format for the diagram, e.g. 'dot', 'gif', 'jpeg', 'jpg', 'pdf', 'png', 'svg'. Default is 'svg'nosvg
dry_runPerform a dry run without actually executing justificationsnofalse
python_exec_pathSpecify a Python interpreter path to run jPipe Runnerno""
python_pathSpecify one or more extra folders to search for Python files/modules, separated by newlinesno
working_directorySpecify a working directory to run jPipe Runnerno.
versionjPipe Runner git ref to install: a tag (e.g. 'v3.5.3'), a branch, or a commit SHA. Installed from git, so this is NOT a PyPI version. Defaults to the main branchnomain
embed_imageIf true, embed diagram in PR comment otherwise only upload as artifactnofalse
image_branchBranch name where the image will be committednojpipe-runner-diagrams
image_repoTarget repo (owner/repo) for committing the image; defaults to current repono""
image_pathPath where image will be stored in the branchnodiagrams/
image_commit_messageCommit message for the generated diagramnoAdd generated diagram from jPipe Runner
github-tokenGitHub token to authenticate (Read & Write access to actions, code, pull requests, and metadata)no
github-readonly-tokenGitHub read permission only token to generate the raw URL of the image for accessing URLs in private repositories (Read access to actions, code, and metadata)no
namedescription
resultExit code of the jPipe Runner execution
diagram_pathPath to the primary generated diagram (first, alphabetically) — see diagram_dir for all of them
diagram_countNumber of diagrams generated (a wildcard `diagram` pattern can match several)
diagram_dirDirectory containing every generated diagram
pr_comment_idID of the PR comment posted