-
-
Notifications
You must be signed in to change notification settings - Fork 587
183 lines (156 loc) · 6.74 KB
/
markdown_equations.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
#/
# @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_equations
# Workflow triggers:
on:
pull_request_target:
branches:
- develop
types:
- closed
paths:
# List paths for which changes should trigger this workflow:
- 'lib/**/*.md'
# Global permissions:
permissions:
# Allow read-only access to the repository contents:
contents: read
# Workflow jobs:
jobs:
# Define a job for updating equations in Markdown files...
update:
# Define a display name:
name: 'Update equations'
# Only run this job if the pull request was merged and did not have label `automated-pr`:
if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'automated-pr') == false
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# 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 100 commits:
fetch-depth: 100
# Specify whether to download Git-LFS files:
lfs: false
timeout-minutes: 10
# Install Node.js:
- name: 'Install Node.js'
# Pin action to full length commit SHA
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
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
# Configure Git:
- name: 'Configure Git'
run: |
git config --local user.email "[email protected]"
git config --local user.name "stdlib-bot"
timeout-minutes: 5
# Import GPG key to sign commits:
- name: 'Import GPG key to sign commits'
# Pin action to full length commit SHA
uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0
with:
gpg_private_key: ${{ secrets.STDLIB_BOT_GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.STDLIB_BOT_GPG_PASSPHRASE }}
git_user_signingkey: true
git_commit_gpgsign: true
# Generate list of changed Markdown files:
- name: 'Find changed Markdown files'
run: |
echo "files=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} -G '<equation' | grep .md | tr '\n' ' ')" >> $GITHUB_OUTPUT
id: changed
# Generate SVG equations:
- name: 'Generate SVG equations'
id: svg-equations
run: |
make markdown-svg-equations-files FILES="${{ steps.changed.outputs.files }}"
if [[ -z "$(git status --porcelain)" ]]; then
# If no files were changed, exit with a success status code:
echo "changed=false" >> $GITHUB_OUTPUT
exit 0
else
# Otherwise, add changed files to the staging area and commit:
git add -A && git commit -m "docs: update Markdown equation SVGs"
echo "changed=true" >> $GITHUB_OUTPUT
fi
timeout-minutes: 15
# Update Markdown equation elements:
- name: 'Update equation elements'
id: equation-elements
run: |
make markdown-img-equations-files FILES="${{ steps.changed.outputs.files }}"
make markdown-img-equations-src-urls-files FILES="${{ steps.changed.outputs.files }}"
if [[ -z "$(git status --porcelain)" ]]; then
# If no files were changed, exit with a success status code:
echo "changed=false" >> $GITHUB_OUTPUT
exit 0
else
# Otherwise, add changed files to the staging area and commit:
git add -A && git commit -m "docs: update Markdown equation elements"
echo "changed=true" >> $GITHUB_OUTPUT
fi
timeout-minutes: 15
# Create a pull request with the updated equations:
- name: 'Create pull request'
id: cpr
if: steps.svg-equations.outputs.changed == 'true' || steps.equation-elements.outputs.changed == 'true'
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # v5.0.2
with:
title: 'docs: update Markdown equation elements'
body: |
This PR
- updates equation elements found in Markdown files
commit-message: 'docs: update Markdown equation elements'
committer: 'stdlib-bot <[email protected]>'
signoff: true
token: ${{ secrets.PULL_REQUEST_TOKEN }}
labels: |
documentation
automated-pr
team-reviewers: |
reviewers
branch: markdown-insert-equations
delete-branch: true
# Create Markdown summary of the pull request:
- name: 'Create summary'
if: steps.svg-equations.outputs.changed == 'true' || steps.equation-elements.outputs.changed == 'true'
run: |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "Pull request ${{ steps.cpr.outputs.pull-request-number }} was successfully ${{ steps.cpr.outputs.pull-request-operation }}."
echo ":link: [${{ steps.cpr.outputs.pull-request-url }}](${{ steps.cpr.outputs.pull-request-url }})." >> $GITHUB_STEP_SUMMARY
echo "Head SHA: [${{ steps.cpr.outputs.pull-request-head-sha }}](${{ steps.cpr.outputs.pull-request-url }}/commits/${{ steps.cpr.outputs.pull-request-head-sha }})." >> $GITHUB_STEP_SUMMARY