Skip to content

Commit 35474e0

Browse files
committed
Make some minor improvements to the comments in "Check Certificates" workflow
1 parent c1a79e7 commit 35474e0

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

.github/workflows/check-certificates.yml

+9-9
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ on:
1010
paths:
1111
- ".github/workflows/check-certificates.ya?ml"
1212
schedule:
13-
# run every 10 hours
13+
# Run every 10 hours.
1414
- cron: "0 */10 * * *"
1515
workflow_dispatch:
1616
repository_dispatch:
1717

1818
env:
19-
# Begin notifications when there are less than this many days remaining before expiration
19+
# Begin notifications when there are less than this many days remaining before expiration.
2020
EXPIRATION_WARNING_PERIOD: 30
2121

2222
jobs:
@@ -32,14 +32,15 @@ jobs:
3232

3333
matrix:
3434
certificate:
35-
- identifier: macOS signing certificate # Text used to identify the certificate in notifications
36-
certificate-secret: INSTALLER_CERT_MAC_P12 # The name of the secret that contains the certificate
37-
password-secret: INSTALLER_CERT_MAC_PASSWORD # The name of the secret that contains the certificate password
35+
# Additional certificate definitions can be added to this list.
36+
- identifier: macOS signing certificate # Text used to identify certificate in notifications.
37+
certificate-secret: INSTALLER_CERT_MAC_P12 # Name of the secret that contains the certificate.
38+
password-secret: INSTALLER_CERT_MAC_PASSWORD # Name of the secret that contains the certificate password.
3839

3940
steps:
4041
- name: Set certificate path environment variable
4142
run: |
42-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
43+
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
4344
echo "CERTIFICATE_PATH=${{ runner.temp }}/certificate.p12" >> "$GITHUB_ENV"
4445
4546
- name: Decode certificate
@@ -61,7 +62,6 @@ jobs:
6162
exit 1
6263
)
6364
64-
# See: https://github.com/rtCamp/action-slack-notify
6565
- name: Slack notification of certificate verification failure
6666
if: failure()
6767
env:
@@ -101,7 +101,7 @@ jobs:
101101
102102
DAYS_BEFORE_EXPIRATION="$((($(date --utc --date="$EXPIRATION_DATE" +%s) - $(date --utc +%s)) / 60 / 60 / 24))"
103103
104-
# Display the expiration information in the log
104+
# Display the expiration information in the log.
105105
echo "Certificate expiration date: $EXPIRATION_DATE"
106106
echo "Days remaining before expiration: $DAYS_BEFORE_EXPIRATION"
107107
@@ -116,7 +116,7 @@ jobs:
116116
fi
117117
118118
- name: Slack notification of pending certificate expiration
119-
# Don't send spurious expiration notification if verification fails
119+
# Don't send spurious expiration notification if verification fails.
120120
if: failure() && steps.check-expiration.outcome == 'failure'
121121
env:
122122
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

0 commit comments

Comments
 (0)