Skip to content

Commit 59b8b87

Browse files
authored
Beautify GH action output (#269)
Add comments to each scripts, as first line is what is being displayed in Github Action output.
1 parent f8c81dd commit 59b8b87

File tree

4 files changed

+13
-1
lines changed

4 files changed

+13
-1
lines changed

actions/run-color-scheme-tests/action.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ runs:
88
using: 'composite'
99
steps:
1010
- run: |
11+
# Run Color Scheme Tests
1112
. $GITHUB_ACTION_PATH/../setup/utils.sh
1213
1314
InstallPackage "ColorSchemeUnit" "https://github.com/gerardroche/sublime-color-scheme-unit"

actions/run-syntax-tests/action.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ runs:
1111
using: 'composite'
1212
steps:
1313
- run: |
14+
# Run Syntax Tests
1415
PACKAGE_FROM_INPUTS="${{ inputs.package-name }}"
1516
PACKAGE="${PACKAGE_FROM_INPUTS:-$PACKAGE}"
1617

actions/run-tests/action.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ runs:
1616
using: 'composite'
1717
steps:
1818
- run: |
19+
# Run UnitTests
1920
PACKAGE_FROM_INPUTS="${{ inputs.package-name }}"
2021
PACKAGE="${PACKAGE_FROM_INPUTS:-$PACKAGE}"
2122
@@ -26,7 +27,8 @@ runs:
2627
fi
2728
shell: bash
2829
- if: inputs.codecov-upload == 'true'
29-
run:
30+
run: |
31+
# Run UnitTests
3032
echo "The setting `codecov-upload` is deprecated."
3133
echo "Please call the action `codecov/codecov-action` directly".
3234
shell: bash

actions/setup/action.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ runs:
6060
steps:
6161
- name: Setup Environment Variables
6262
run: |
63+
# Setup Environment Variables
6364
if [ "${{ runner.os }}" = "Windows" ]; then
6465
echo "c:\st" >> $GITHUB_PATH
6566
else
@@ -98,6 +99,7 @@ runs:
9899
- name: Setup Graphical User Interface
99100
if: runner.os == 'Linux'
100101
run: |
102+
# Setup Graphical User Interface
101103
sudo bash $GITHUB_ACTION_PATH/install_ubuntu_sys_req.sh
102104
echo "DISPLAY=:1" >> $GITHUB_ENV
103105
# install display driver
@@ -120,6 +122,7 @@ runs:
120122
- name: Start Graphical User Interface
121123
if: runner.os == 'Linux'
122124
run: |
125+
# Start Graphical User Interface
123126
case ${{ inputs.display }} in
124127
xvfb)
125128
Xvfb $DISPLAY -screen 0 1024x768x24 -ac +extension GLX +render -noreset &
@@ -146,6 +149,7 @@ runs:
146149
shell: bash
147150
- name: Install Sublime Text
148151
run: |
152+
# Install Sublime Text
149153
# download and install Sublime Text
150154
if [ "${{ runner.os }}" = "Windows" ]; then
151155
pwsh $GITHUB_ACTION_PATH/install_sublime_text.ps1 --verbose;
@@ -157,6 +161,7 @@ runs:
157161
shell: bash
158162
- name: Determine Test Package
159163
run: |
164+
# Determine Test Package
160165
REPO="$GITHUB_REPOSITORY"
161166
if [ "${{ inputs.install-package }}" = "true" ]; then
162167
cd "${{ inputs.package-path }}"
@@ -174,6 +179,8 @@ runs:
174179
shell: bash
175180
- name: Install Packages
176181
run: |
182+
# Install Packages
183+
177184
# Disable warnings about detached HEAD
178185
# https://stackoverflow.com/questions/36794501
179186
git config --global advice.detachedHead false
@@ -222,6 +229,7 @@ runs:
222229
- name: Install Package Control
223230
if: inputs.install-package-control == 'true'
224231
run: |
232+
# Install Package Control
225233
if [ "${{ runner.os }}" = "Windows" ]; then
226234
pwsh $GITHUB_ACTION_PATH/install_package_control.ps1 --verbose;
227235
else

0 commit comments

Comments
 (0)