This action is intended for building dependencies graph between issues in epic, rendering mermaid diagram with this graph and automatically updating epic issue body with diagram. It can be useful during work on big epics where it is tricky to keep all dependencies in mind.
All nodes of diagram are clickable and link leads to issue page. Also nodes are colored according to issue status: Green (issue is closed), Yellow (issue is opened and someone is assigned to it), White (issue is opened and no assignees).
| Parameter | Description |
|---|---|
root-issue-url |
Url of the root issue |
section-title |
Title of markdown section where mermaid chart should be placed |
github-token |
GitHub API Token with read and write access to root issue and read access to all issues in the tasklist |
include-legend |
Set this option to include legend to mermaid diagram |
include-finish-node |
Set this option to include finish node to mermaid diagram |
dry-run |
Set this option to not update root issue with updated mermaid diagram and only print new diagram to output |
-
Update root issue body to include task list with all children issues:
- [ ] https://github.com/owner/repo/issues/2 - [ ] https://github.com/owner/repo/issues/3 - [ ] https://github.com/owner/repo/issues/4 ... -
Create an empty section in root issue body to which mermaid diagram will be inserted:
... ## Spec Diagram ... -
Update all children issues to define their dependencies in issues body using one of the following syntax:
Depends on https://github.com/owner/repo/issues/2, https://github.com/owner/repo/issues/3 Depends on: https://github.com/owner/repo/issues/2 https://github.com/owner/repo/issues/3 Dependencies: https://github.com/owner/repo/issues/2, https://github.com/owner/repo/issues/3Any of the format above can be used one or multiple times in issue body. Any separator can be used for issues in line.
-
Add workflow to invoke this action:
jobs: update-diagram: runs-on: ubuntu-latest steps: - uses: maxim-lobanov/build-issue-dependencies-graph@v1 with: root-issue-url: 'https://github.com/owner/repo/issues/1' section-title: 'Spec Diagram' github-token: '${{ secrets.GITHUB_TOKEN }}' include-legend: true include-finish-node: true
on:
schedule:
- cron: '0 */12 * * *' # Twice per day
jobs:
run:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include:
- root-issue-url: 'https://github.com/owner/repo/issues/1'
section-title: 'Spec Diagram'
- root-issue-url: 'https://github.com/owner/repo/issues/2'
section-title: 'Spec Diagram'
steps:
- uses: maxim-lobanov/build-issue-dependencies-graph@v1
name: 'Build issues dependency graph'
id: build-issue-dependencies-graph
with:
root-issue-url: '${{ matrix.root-issue-url }}'
section-title: '${{ matrix.section-title }}'
github-token: '${{ secrets.GITHUB_TOKEN }}'
include-legend: true
include-finish-node: true
on:
workflow_dispatch:
inputs:
root-issue-url:
description: 'Root issue url'
required: true
type: string
section-title:
description: 'Section title'
required: true
type: string
include-legend:
description: 'Include legend'
type: boolean
include-finish-node:
description: 'Include finish node'
type: boolean
dry-run:
description: 'Dry run'
type: boolean
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: maxim-lobanov/build-issue-dependencies-graph@v1
name: 'Build issues dependency graph'
id: build-issue-dependencies-graph
with:
root-issue-url: '${{ github.event.inputs.root-issue-url }}'
section-title: '${{ github.event.inputs.section-title }}'
github-token: '${{ secrets.GITHUB_TOKEN }}'
include-legend: '${{ github.event.inputs.include-legend }}'
include-finish-node: '${{ github.event.inputs.include-finish-node }}'
dry-run: '${{ github.event.inputs.dry-run }}'
- run: |
cat << 'EOF' > $GITHUB_STEP_SUMMARY
${{ steps.build-issue-dependencies-graph.outputs.mermaid-diagram }}
EOFflowchart TD
%% <Legend>
legend --> start
subgraph legend["Legend"]
direction LR;
notstarted("Issue is not started"):::notstarted;
started("Issue is in progress"):::started;
completed("Issue is done"):::completed;
notstarted --> started --> completed;
end
%% </Legend>
%% <CSS>
classDef notstarted fill:#FFF,color:#000;
classDef started fill:#fae17d,color:#000;
classDef completed fill:#ccffd8,color:#000;
%% </CSS>
%% <Issues>
start("Start"):::default;
issue1488484564("[TEST ISSUE] Child issue 1"):::completed;
click issue1488484564 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/2" _blank;
issue1488484695("[TEST ISSUE] Child issue 2"):::completed;
click issue1488484695 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/3" _blank;
issue1488484833("[TEST ISSUE] Child issue 3"):::started;
click issue1488484833 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/4" _blank;
issue1524488391("[TEST ISSUE] Child issue 4"):::completed;
click issue1524488391 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/5" _blank;
issue1524488450("[TEST ISSUE] Child issue 5"):::started;
click issue1524488450 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/6" _blank;
issue1524488472("[TEST ISSUE] Child issue 6"):::notstarted;
click issue1524488472 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/7" _blank;
issue1524488513("[TEST ISSUE] Child issue 7"):::notstarted;
click issue1524488513 href "https://github.com/maxim-lobanov/build-issue-dependencies-graph/issues/8" _blank;
finish("Finish"):::default;
%% </Issues>
%% <Dependencies>
start --> issue1488484564;
start --> issue1488484695;
start --> issue1524488391;
start --> issue1524488450;
issue1488484564 --> issue1488484833;
issue1488484695 --> issue1488484833;
issue1488484833 --> issue1524488472;
issue1524488450 --> issue1524488472;
issue1524488450 --> issue1524488513;
issue1524488391 --> finish;
issue1524488472 --> finish;
issue1524488513 --> finish;
%% </Dependencies>