forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
230 lines (191 loc) · 7.57 KB
/
markdown_links.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
#/
# @license Apache-2.0
#
# Copyright (c) 2021 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/
# Workflow name:
name: markdown_links
# Workflow triggers:
on:
schedule:
# Run the workflow once a month on the 1st day of every month:
- cron: "0 0 1 * *"
# Allow the workflow to be manually run:
workflow_dispatch:
# Global permissions:
permissions:
# Allow read-only access to the repository contents:
contents: read
# Workflow jobs:
jobs:
# Define a job for detecting broken links in Markdown files...
markdown_links:
# Define a display name:
name: 'Check links'
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define environment variables:
env:
LOG_DIR: "${{ github.workspace }}/tmp/var/log"
LOG_FILE_FAILURES: "${{ github.workspace }}/tmp/var/log/failures.json"
LOG_FILE_WARNINGS: "${{ github.workspace }}/tmp/var/log/warnings.json"
# Set defaults:
defaults:
run:
# Set the default shell to `bash`:
shell: bash --noprofile --norc -eo pipefail {0}
# Define the sequence of job steps...
steps:
# Checkout the repository:
- name: 'Checkout repository'
# Pin action to full length commit SHA
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
# Specify whether to remove untracked files before checking out the repository:
clean: true
# Limit clone depth to the most recent commit:
fetch-depth: 1
# Specify whether to download Git-LFS files:
lfs: false
timeout-minutes: 10
# Initialize log files:
- name: 'Initialize log files'
run: |
mkdir -p "${{ env.LOG_DIR }}"
touch "${{ env.LOG_FILE_FAILURES }}"
touch "${{ env.LOG_FILE_WARNINGS }}"
timeout-minutes: 2
# Check for broken links:
- name: 'Check links'
uses: stdlib-js/check-markdown-link-definitions-action@main
id: results
with:
exclude: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules
timeout-minutes: 240
# Install Node.js:
- name: 'Install Node.js'
# Pin action to full length commit SHA
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: '16' # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- name: 'Install dependencies'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- name: 'Initialize development environment'
run: |
make init
timeout-minutes: 5
# Check whether links are included in `docs/links/database.json` and use the correct identifier:
- name: 'Check links against database'
run: |
# Determine root directory:
root=$(git rev-parse --show-toplevel)
# Define the path to a utility for validating links:
validate="${root}/lib/node_modules/@stdlib/_tools/links/validate/bin/cli"
echo "## Link Validation" >> $GITHUB_STEP_SUMMARY
output=$(echo '${{ steps.results.outputs.all_links }}' | ${validate})
if [[ "${output}" != "All links are valid." ]]; then
echo "| URL | ID | Error |" >> $GITHUB_STEP_SUMMARY
echo "| --- | -- | ----- |" >> $GITHUB_STEP_SUMMARY
echo "$output" | jq -r '.[] | [.error, .id, .url] | @tsv' | while IFS=$'\t' read -r error id url; do
echo "| $url | \`$id\` | $error |" >> $GITHUB_STEP_SUMMARY
done
else
echo "$output"
fi
# Log the results:
- name: 'Log results'
run: |
echo ${{ steps.results.outputs.failures }} >> "${{ env.LOG_FILE_FAILURES }}"
echo ${{ steps.results.outputs.warnings }} >> "${{ env.LOG_FILE_WARNINGS }}"
timeout-minutes: 2
# Fail the workflow if the status is not "success":
- name: 'Check status'
if: ${{ steps.results.outputs.status }} != 'success'
run: |
exit 1
# View the log file if the previous step fails:
- name: 'View log file'
if: failure()
run: |
echo "Printing the list of failures..."
cat "${{ env.LOG_FILE_FAILURES }}"
timeout-minutes: 5
# Upload the log files:
- name: 'Upload log files'
# Pin action to full length commit SHA
uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
if: always()
with:
# Define a name for the uploaded artifact:
name: results
# Specify the paths to upload:
path: |
${{ env.LOG_FILE_FAILURES }}
${{ env.LOG_FILE_WARNINGS }}
# Specify the number of days to retain the artifact (default is 90 days):
retention-days: 10
timeout-minutes: 10
# Define a job for sending notifications to Slack...
slack:
# Define a display name:
name: 'Slack notification'
# Define the type of virtual host machine:
runs-on: 'ubuntu-latest'
# Indicate that this job depends on the prior job finishing:
needs: markdown_links
# Run this job regardless of the outcome of the prior job:
if: always()
# Set defaults:
defaults:
run:
# Set the default shell to `bash`:
shell: bash --noprofile --norc -eo pipefail {0}
# Define the sequence of job steps...
steps:
# Resolve notification data:
- name: 'Resolve notification data'
run: |
echo 'NOTIFICATION_STATUS=${{ needs.markdown_links.result}}' >> $GITHUB_ENV
if [[ "${{ needs.markdown_links.result }}" = "success" ]]; then
echo 'NOTIFICATION_TEXT=**markdown_links** workflow succeeded' >> $GITHUB_ENV
echo 'NOTIFICATION_AUTHOR_NAME=Success' >> $GITHUB_ENV
elif [[ "${{ needs.markdown_links.result }}" = "failure" ]]; then
echo 'NOTIFICATION_TEXT=**markdown_links** workflow failed' >> $GITHUB_ENV
echo 'NOTIFICATION_AUTHOR_NAME=Failure' >> $GITHUB_ENV
elif [[ "${{ needs.markdown_links.result }}" = "cancelled" ]]; then
echo 'NOTIFICATION_TEXT=**markdown_links** workflow was canceled' >> $GITHUB_ENV
echo 'NOTIFICATION_AUTHOR_NAME=Canceled' >> $GITHUB_ENV
else
exit 1
fi
timeout-minutes: 5
# Send notification to Slack:
- name: 'Send notification'
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
with:
status: "${{ env.NOTIFICATION_STATUS }}"
fields: repo,commit,message
text: "${{ env.NOTIFICATION_TEXT }}"
author_name: "${{ env.NOTIFICATION_AUTHOR_NAME }}"
env:
SLACK_WEBHOOK_URL: ${{ secrets.REPO_SLACK_WEBHOOK_URL }}
timeout-minutes: 5