Skip to content

Commit d2c7957

Browse files
ci: preconfigure CI jobs
1 parent 852c219 commit d2c7957

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/dependabot.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
day: 'sunday'
8+
time: '02:00'
9+
timezone: Europe/Berlin
10+
groups:
11+
dependencies:
12+
dependency-type: production
13+
patterns:
14+
- '*'
15+
dev-dependencies:
16+
dependency-type: development
17+
patterns:
18+
- '*'
19+
- package-ecosystem: github-actions
20+
directory: /
21+
schedule:
22+
interval: weekly
23+
day: 'sunday'
24+
time: '04:00'
25+
timezone: Europe/Berlin
26+
groups:
27+
all:
28+
patterns:
29+
- '*'

.github/workflows/check-format.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,34 @@ jobs:
2929

3030
- name: Run format check
3131
run: npm run check-format
32+
check-docs:
33+
runs-on: ubuntu-latest # You can also use 'macos-latest' or 'windows-latest'
34+
35+
steps:
36+
- name: Check out repository
37+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
38+
with:
39+
fetch-depth: 2
40+
41+
- name: Set up Node.js
42+
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
43+
with:
44+
cache: npm
45+
node-version-file: '.nvmrc'
46+
47+
- name: Install dependencies
48+
run: npm ci
49+
50+
- name: Generate documents
51+
run: npm run generate-docs
52+
- name: Check if autogenerated docs differ
53+
run: |
54+
diff_file=$(mktemp doc_diff_XXXXXX)
55+
git diff --color > $diff_file
56+
if [[ -s $diff_file ]]; then
57+
echo "Please update the documentation by running 'npm run docs'. The following was the diff"
58+
cat $diff_file
59+
rm $diff_file
60+
exit 1
61+
fi
62+
rm $diff_file

0 commit comments

Comments
 (0)