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
The commit involves a restructured list in the README to enhance readability. Instructions under 'Installation', 'Execution', and 'Integration with GitHub Actions' are now indented properly to be subordinate to their respective sections. The examples are also moved into a separate section for better clarity and organization.
Copy file name to clipboardExpand all lines: README.md
+9-11
Original file line number
Diff line number
Diff line change
@@ -25,22 +25,20 @@ The development of this tool was inspired by articles from :
25
25
To use the PHP AST Check Diff Tool, follow these steps:
26
26
27
27
1. Installation:
28
-
- Run `composer require --dev o0h/ast-check-diff` to install the tool.
29
-
28
+
- Run `composer require --dev o0h/ast-check-diff` to install the tool.
30
29
2. Execution:
31
-
- Execute `vendor/bin/ast-check-diff check` to perform a comparison and output a Markdown document to standard output.
32
-
- The `--head` and `--base` options can be passed via CLI to specify the source and destination of the comparison. Branch names, tags, or commit hashes can be used for this purpose.
30
+
- Execute `vendor/bin/ast-check-diff check` to perform a comparison and output a Markdown document to standard output.
31
+
- The `--head` and `--base` options can be passed via CLI to specify the source and destination of the comparison. Branch names, tags, or commit hashes can be used for this purpose.
32
+
3. Integration with GitHub Actions:
33
+
- Integrating this tool with GitHub Actions for deep collaboration with pull requests is highly recommended.
34
+
- Example code of workflow: [GitHub Workflow](https://github.com/o0h/php-ast-check-diff/blob/main/.github/workflows/php-ast-check-diff.yml)
35
+
- Example of operation: [GitHub Pull Request Example](https://github.com/o0h/php-ast-check-diff/pull/5#issuecomment-1867274471)
36
+
33
37
34
-
examples:
38
+
examples:
35
39
-`vendor/bin/ast-check-diff check ast-diff-check` : If the `--head` option is omitted, `HEAD` is implicitly specified, and if the `--base` option is omitted, the `main` branch is implicitly specified.
36
40
-`vendor/bin/ast-check-diff check ast-diff-check --base HEAD@{3} --head HEAD~` : These comparisons are made by specifying pointers.
37
41
-`vendor/bin/ast-check-diff check ast-diff-check --base cd2f816 --head 1a89b0c` : These comparisons are made by specifying specific commits.
38
-
39
-
3. Integration with GitHub Actions:
40
-
- Integrating this tool with GitHub Actions for deep collaboration with pull requests is highly recommended.
41
-
- Example code of workflow: [GitHub Workflow](https://github.com/o0h/php-ast-check-diff/blob/main/.github/workflows/php-ast-check-diff.yml)
42
-
- Example of operation: [GitHub Pull Request Example](https://github.com/o0h/php-ast-check-diff/pull/5#issuecomment-1867274471)
43
-
44
42
## Notes
45
43
- This tool is intended for use with the latest PHP environments(8.3 or 8.2+).
46
44
- Includes composer.lock: The project includes a composer.lock file.
0 commit comments