Skip to content

Commit 9e91a91

Browse files
authored
Merge pull request #32 from ysk8hori/update-readme
readme の画像を削除、typescript-graph に付いての記載を追加
2 parents 1b91073 + 2bad18c commit 9e91a91

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
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.
44

5-
![sample image](img/2023-11-21-22-29-19.png)
5+
![sample](img/top-sample.png)
66

7-
### Sample Usage
7+
## Sample Usage
88

9-
#### Basic File Modifications
9+
### Basic File Modifications
1010

1111
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.
1212

@@ -33,11 +33,11 @@ flowchart
3333
src/index.ts-->src/utils
3434
```
3535

36-
#### Changes Involving File Deletion or Movement
36+
### Changes Involving File Deletion or Movement
3737

3838
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.
3939

40-
##### Base Branch
40+
#### Base Branch
4141

4242
```mermaid
4343
flowchart
@@ -62,7 +62,7 @@ flowchart
6262
src/index.test.ts-->src/index.ts
6363
```
6464

65-
##### Head Branch
65+
#### Head Branch
6666

6767
```mermaid
6868
flowchart
@@ -139,3 +139,10 @@ steps:
139139
```
140140

141141
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:
148+
https://github.com/ysk8hori/typescript-graph

img/2023-11-21-22-29-19.png

-105 KB
Binary file not shown.

img/top-sample.png

124 KB
Loading

0 commit comments

Comments
 (0)