Skip to content

Commit b2fe37a

Browse files
PDowneyPDowney
authored
added debug command
1 parent 914a34e commit b2fe37a

6 files changed

Lines changed: 364 additions & 22 deletions

File tree

‎.github/workflows/branch-cleanup.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Branch Cleanup
2+
3+
on:
4+
pull_request:
5+
types: [closed]
6+
7+
jobs:
8+
cleanup:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Delete merged branch
12+
uses: SvanBoxel/delete-merged-branch@main
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+

‎.github/workflows/welcom.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Welcome
2+
3+
on:
4+
pull_request_target:
5+
types: [opened]
6+
issues:
7+
types: [opened]
8+
9+
jobs:
10+
welcome:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/first-interaction@v1
14+
with:
15+
repo-token: ${{ secrets.GITHUB_TOKEN }}
16+
issue-message: |
17+
Thanks for opening your first issue in EngineScript! 🚀
18+
19+
To help us better understand your issue, please run:
20+
```bash
21+
es.debug
22+
```
23+
24+
This command will generate a detailed report including:
25+
- System information
26+
- Software versions
27+
- Configuration settings
28+
- Service status
29+
- Network information
30+
31+
⚠️ **Important Privacy Note**
32+
Before sharing the debug output, please review and remove any sensitive information that you don't want to share publicly. This may include:
33+
- IP addresses
34+
- Hostnames
35+
- Domain names
36+
37+
The debug report is saved to a file and formatted specifically for GitHub.
38+
After reviewing and sanitizing the content, paste it into your issue.
39+
40+
We'll review your issue soon!
41+
42+
pr-message: |
43+
Thanks for your first contribution to EngineScript! 🎉
44+
45+
If your PR fixes an issue, please consider including the sanitized output
46+
of `es.debug` to show the environment where you tested your changes.
47+
Remember to remove any sensitive information before sharing.
48+
49+
We'll review your PR soon!

‎README.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -168,21 +168,23 @@ For more information, see [This is Brotli from Origin](https://blog.cloudflare.c
168168

169169
### EngineScript Commands
170170

171+
### EngineScript Commands
172+
171173
|Command|Function|
172174
|-|-|
173-
|**`es.backup`** |Runs the backup script to backup all domains locally and *optionally* in the cloud |
174-
|**`es.cache`** |Clear FastCGI Cache, OpCache, and Redis *(server-wide)* |
175-
|**`es.config`** |Opens the configuration file in Nano |
176-
|**`es.help`** |Displays EngineScript commands and important directories |
177-
|**`es.images`** |Losslessly compress all images in the WordPress /uploads directory *(server-wide)* |
178-
|**`es.info`** |Displays server information |
179-
|**`es.install`** |Runs the main EngineScript installation script |
180-
|**`es.menu`** |EngineScript menu |
175+
|**`es.backup`** |Runs the backup script to backup all domains locally and *optionally* in the cloud |
176+
|**`es.cache`** |Clear FastCGI Cache, OpCache, and Redis *(server-wide)* |
177+
|**`es.config`** |Opens the configuration file in Nano |
178+
|**`es.debug`** |Displays debug information for EngineScript |
179+
|**`es.help`** |Displays EngineScript commands and locations |
180+
|**`es.images`** |Losslessly compress all images in the WordPress /uploads directory *(server-wide)* |
181+
|**`es.info`** |Displays server information |
182+
|**`es.install`** |Runs the main EngineScript installation script |
183+
|**`es.menu`** |EngineScript menu |
181184
|**`es.permissions`** |Resets the permissions of all files in the WordPress directory *(server-wide)* |
182-
|**`es.restart`** |Restart Nginx and PHP |
183-
|**`es.server`** |Displays server information |
184-
|**`es.update`** |Update EngineScript |
185-
|**`es.variables`** |Opens the variable file in Nano. This file resets when EngineScript is updated |
185+
|**`es.restart`** |Restart Nginx and PHP |
186+
|**`es.update`** |Update EngineScript |
187+
|**`es.variables`** |Opens the variable file in Nano. This file resets when EngineScript is updated |
186188

187189
### Software EngineScript Utilizes:
188190

‎config/var/www/admin/control-panel/index.html‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ <h3>EngineScript Commands</h3>
6060
.tg .tg-fymr{border-color:inherit;font-weight:bold;text-align:left;vertical-align:top}
6161
.tg .tg-0pky{border-color:inherit;text-align:left;vertical-align:top}
6262
</style>
63+
6364
<table class="tg"><thead>
6465
<tr>
6566
<th class="tg-4xln">COMMAND</th>
@@ -78,21 +79,25 @@ <h3>EngineScript Commands</h3>
7879
<td class="tg-fymr">es.config</td>
7980
<td class="tg-0pky">Opens the configuration file in Nano</td>
8081
</tr>
82+
<tr>
83+
<td class="tg-fymr">es.debug</td>
84+
<td class="tg-0pky">Displays debug information for EngineScript</td>
85+
</tr>
8186
<tr>
8287
<td class="tg-fymr">es.help</td>
83-
<td class="tg-0pky">Displays EngineScript commands and important directories</td>
88+
<td class="tg-0pky">Displays EngineScript commands and locations</td>
8489
</tr>
8590
<tr>
8691
<td class="tg-fymr">es.images</td>
87-
<td class="tg-0pky">Losslessly compress all images in the WordPress /uploads directory<span style="font-style:italic"> (server-wide)</span></td>
92+
<td class="tg-0pky">Losslessly compress all images in the WordPress /uploads directory <span style="font-style:italic">(server-wide)</span></td>
8893
</tr>
8994
<tr>
9095
<td class="tg-fymr">es.info</td>
9196
<td class="tg-0pky">Displays server information</td>
9297
</tr>
9398
<tr>
9499
<td class="tg-fymr">es.install</td>
95-
<td class="tg-0pky">Runs the main EngineScript installation scrip</td>
100+
<td class="tg-0pky">Runs the main EngineScript installation script</td>
96101
</tr>
97102
<tr>
98103
<td class="tg-fymr">es.menu</td>
@@ -106,10 +111,6 @@ <h3>EngineScript Commands</h3>
106111
<td class="tg-fymr">es.restart</td>
107112
<td class="tg-0pky">Restart Nginx and PHP</td>
108113
</tr>
109-
<tr>
110-
<td class="tg-fymr">es.server</td>
111-
<td class="tg-0pky">Displays server information</td>
112-
</tr>
113114
<tr>
114115
<td class="tg-fymr">es.update</td>
115116
<td class="tg-0pky">Update EngineScript</td>

0 commit comments

Comments
 (0)