Skip to content

Commit a613edf

Browse files
committed
better comments
1 parent 1b12ce6 commit a613edf

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

.github/workflows/pylint.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ jobs:
5959
6060
- name: Create custom Pylint Report in HTML format (refined version)
6161
run: |
62-
# Read the pylint output and create a custom HTML report, to be saved to
63-
# https://sandialabs.github.io/rattlesnake-vibration-controller/reports/pylint/
62+
# Read the pylint output and create a custom HTML report.
6463
python src/rattlesnake/cicd/report_pylint.py \
6564
--input_file ${{ env.PYLINT_OUTPUT_FILE }} \
6665
--output_file pylint_report.html \
@@ -70,7 +69,7 @@ jobs:
7069
--github_sha ${{ github.sha }} \
7170
--github_repo ${{ github.repository }}
7271
73-
- name: Create GitHub Pages content
72+
- name: Create GitHub Pages Pylint content
7473
if: github.ref == 'refs/heads/dev' # Only deploy on dev branch
7574
run: |
7675
# Create pages directory structure
@@ -79,9 +78,9 @@ jobs:
7978
# Copy the pylint report as the main report
8079
cp pylint_report.html pages/reports/pylint/index.html
8180
82-
# Access at
81+
# Access the custom Pylint HTML report at
8382
# https://sandialabs.github.io/rattlesnake-vibration-controller/reports/pylint/index.html
84-
83+
#
8584
8685
- name: Create root index.html for GitHub Pages
8786
if: github.ref == 'refs/heads/dev'
@@ -116,6 +115,10 @@ jobs:
116115
</body>
117116
</html>
118117
EOF
118+
119+
# Access the custom HTML report at
120+
# https://sandialabs.github.io/rattlesnake-vibration-controller/
121+
#
119122
120123
- name: Create pylint badge with GitHub Pages link
121124
# if: github.ref == 'refs/heads/main' # Only create badge on main branch

0 commit comments

Comments
 (0)