You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
This GitHub Action uses Mermaid to visualize in a diagram the files that were changed in a Pull Request and their related dependency files. This approach aims to reduce the initial cognitive load during the review process and assist in understanding the structure around the modified code.
4
4
5
-

5
+

6
6
7
-
###Sample Usage
7
+
## Sample Usage
8
8
9
-
####Basic File Modifications
9
+
### Basic File Modifications
10
10
11
11
In this example, we show the dependency graph when you've modified `outputGraph.ts` and its related test files. The modified files are highlighted in yellow, and the files they depend on are also explicitly displayed on the graph.
12
12
@@ -33,11 +33,11 @@ flowchart
33
33
src/index.ts-->src/utils
34
34
```
35
35
36
-
####Changes Involving File Deletion or Movement
36
+
### Changes Involving File Deletion or Movement
37
37
38
38
This case demonstrates the impact when a file is deleted or moved. Dependency graphs are generated for both the base branch and the head branch. Deleted files are displayed in a grayed-out manner.
39
39
40
-
#####Base Branch
40
+
#### Base Branch
41
41
42
42
```mermaid
43
43
flowchart
@@ -62,7 +62,7 @@ flowchart
62
62
src/index.test.ts-->src/index.ts
63
63
```
64
64
65
-
#####Head Branch
65
+
#### Head Branch
66
66
67
67
```mermaid
68
68
flowchart
@@ -139,3 +139,10 @@ steps:
139
139
```
140
140
141
141
This configuration will set up the Action with the specified parameters, allowing you to customize its behavior according to your project's needs.
142
+
143
+
## About the `tsg` Command
144
+
145
+
Using the `tsg` command found in the comments generated by this action, you can achieve results similar to the graphs produced by this action. Modifying the arguments of the `tsg` command may also yield better results.
146
+
147
+
For more information about the `tsg` command, please refer to the following repository:
0 commit comments