-
Notifications
You must be signed in to change notification settings - Fork 23
105 lines (83 loc) · 2.97 KB
/
general.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
name: General
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
jobs:
run-checks:
name: Run Checks
permissions: {}
timeout-minutes: 30
runs-on: intel-ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Lint Markdown files
uses: DavidAnson/markdownlint-cli2-action@v11
with:
globs: '**/*.md'
- name: Check Markdown links
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: yes # output is too noisy, see https://github.com/gaurav-nelson/github-action-markdown-link-check/issues/121
config-file: .github/configs/mlc_config.json
# get submodules *after* checking markdown, we dont care about markdown errors in submodules
- name: Checkout submodules
run: git submodule update --init --recursive
- name: Setup Dart
uses: dart-lang/setup-dart@v1
- name: Install project dependencies
run: tool/gh_actions/install_dependencies.sh
- name: Verify project formatting
run: tool/gh_actions/verify_formatting.sh
- name: Analyze project source
run: tool/gh_actions/analyze_source.sh
- name: Check project documentation
run: tool/gh_actions/check_documentation.sh
- name: Run project tests
run: tool/gh_actions/run_tests.sh
- name: Install CAD Suite (includes yosys)
run: tool/gh_actions/install_opencadsuite.sh
- name: Install D3 Schematic viewer
run: tool/gh_actions/install_d3_hwschematic.sh
- name: Generate HTML for examples
run: tool/gh_actions/create_htmls.sh
# https://github.com/devcontainers/ci/blob/main/docs/github-action.md
- name: Build dev container and run tests in it
uses: devcontainers/[email protected]
with:
runCmd: tool/gh_actions/run_tests.sh
deploy-documentation:
name: Deploy Documentation
needs: run-checks
if: github.event_name == 'push'
permissions:
contents: write # required for "JamesIves/github-pages-deploy-action"
timeout-minutes: 30
runs-on: intel-ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
submodules: recursive
- name: Setup Dart
uses: dart-lang/setup-dart@v1
- name: Install project dependencies
run: tool/gh_actions/install_dependencies.sh
- name: Install CAD Suite (includes yosys)
run: tool/gh_actions/install_opencadsuite.sh
- name: Install D3 Schematic viewer
run: tool/gh_actions/install_d3_hwschematic.sh
- name: Generate project documentation
run: tool/gh_actions/generate_documentation.sh
- name: Generate HTML for examples
run: tool/gh_actions/create_htmls.sh
- name: Deploy generated documentation
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: doc/api
branch: docs