forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
130 lines (108 loc) · 4 KB
/
update_repl_docs.yml
File metadata and controls
130 lines (108 loc) · 4 KB
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
#/
# @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: update_repl_docs
# Workflow triggers:
on:
pull_request:
branches:
- develop
types:
- closed
paths:
# List paths for which changes should trigger this workflow:
- 'lib/**/namespace/lib/**'
- 'lib/**/docs/repl.txt'
# List paths for which changes should *not* trigger this workflow:
- '!lib/**/_tools/**'
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow jobs:
jobs:
# Define a job for updating REPL documentation...
update:
# Define a display name:
name: 'Update REPL docs'
# Only run this job if the pull request was merged (or the job was triggered manually):
if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
# Checkout the repository:
- name: 'Checkout repository'
uses: actions/checkout@v3
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
# Install Node.js:
- name: 'Install Node.js'
uses: actions/setup-node@v3
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
# Update REPL documentation:
- name: 'Update documentation'
run: |
make repl-docs
# Disable Git hooks:
- name: 'Disable Git hooks'
run: |
rm -rf .git/hooks
# Create a pull request:
- name: 'Create pull request'
id: cpr
uses: peter-evans/create-pull-request@v4
with:
title: 'Update REPL namespace'
body: |
This PR
- updates the REPL namespace
commit-message: 'Update REPL namespace'
committer: 'stdlib-bot <noreply@stdlib.io>'
token: ${{ secrets.PULL_REQUEST_TOKEN }}
labels: |
documentation
automated-pr
team-reviewers: |
stdlib-reviewers
branch: update-repl-docs
delete-branch: true
# Create a pull request summary:
- name: 'Create summary'
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