-
Notifications
You must be signed in to change notification settings - Fork 136
126 lines (100 loc) · 3.42 KB
/
docs.yaml
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
# Enforces Rust Docs sanity (protocols crates only)
# If `cargo doc --all-features` fails for one crate, the entire workflow fails
name: Rust Docs
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
cargo-doc-all-features:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- uses: actions/checkout@v4
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Rust Docs crate common
run: |
cd common
cargo doc --all-features
- name: Rust Docs crate buffer_sv2
run: |
cd utils/buffer
cargo doc --all-features
- name: Rust Docs crate no_serde_sv2_derive_codec
run: |
cd protocols/v2/binary-sv2/no-serde-sv2/derive_codec
cargo doc --all-features
- name: Rust Docs crate no_serde_sv2_codec
run: |
cd protocols/v2/binary-sv2/no-serde-sv2/codec
cargo doc --all-features
- name: Rust Docs crate serde_sv2
run: |
cd protocols/v2/binary-sv2/serde-sv2
cargo doc --all-features
- name: Rust Docs crate binary_sv2
run: |
cd protocols/v2/binary-sv2/binary-sv2
cargo doc --all-features
- name: Rust Docs crate const_sv2
run: |
cd protocols/v2/const-sv2
cargo doc --all-features
- name: Rust Docs crate framing_sv2
run: |
cd protocols/v2/framing-sv2
cargo doc --all-features
- name: Rust Docs crate noise_sv2
run: |
cd protocols/v2/noise-sv2
cargo doc --all-features
- name: Rust Docs crate codec_sv2
run: |
cd protocols/v2/codec-sv2
cargo doc --all-features
# todo: blocked by no_std migration
# for more details, see https://github.com/stratum-mining/stratum/issues/1311#issuecomment-2556243364
# - name: Rust Docs crate common_messages
# run: |
# cd protocols/v2/subprotocols/common-messages
# cargo doc --all-features
# todo: blocked by no_std migration
# for more details, see https://github.com/stratum-mining/stratum/issues/1311#issuecomment-2556243364
# - name: Rust Docs crate job_declaration
# run: |
# cd protocols/v2/subprotocols/job-declaration
# cargo doc --all-features
# todo: blocked by no_std migration
# for more details, see https://github.com/stratum-mining/stratum/issues/1311#issuecomment-2556243364
# - name: Rust Docs crate mining
# run: |
# cd protocols/v2/subprotocols/mining
# cargo doc --all-features
# todo: blocked by no_std migration
# for more details, see https://github.com/stratum-mining/stratum/issues/1311#issuecomment-2556243364
# - name: Rust Docs crate template_distribution
# run: |
# cd protocols/v2/subprotocols/template-distribution
# cargo doc --all-features
- name: Rust Docs crate sv2_ffi
run: |
cd protocols/v2/sv2-ffi
cargo doc --all-features
# todo: blocked by roles_logic_sv2 docs PR
# https://github.com/stratum-mining/stratum/pull/1263
# - name: Rust Docs crate roles_logic_sv2
#
# run: |
# cd protocols/v2/roles-logic-sv2
# cargo doc --all-features
- name: Rust Docs crate sv1_api
run: |
cd protocols/v1
cargo doc --all-features