Skip to content

Commit 4433dc4

Browse files
AlenarAlenar
committed
Remove matrix from doc build to reduce cache size
1 parent 914f63f commit 4433dc4

File tree

2 files changed

+16
-67
lines changed

2 files changed

+16
-67
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 11 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -7,65 +7,38 @@ on:
77

88
jobs:
99
cargo-doc:
10-
if: github.event.pull_request.draft == false
1110
runs-on: ubuntu-22.04
12-
strategy:
13-
fail-fast: false
14-
matrix:
15-
include:
16-
- project: mithril-core
17-
cargo_project_name: mithril
18-
- project: mithril-common
19-
- project: mithril-aggregator
20-
- project: mithril-client
21-
- project: mithril-signer
22-
env:
23-
CARGO_PROJECT_NAME: ${{ matrix.project }}
24-
2511
steps:
2612
- name: Checkout sources
2713
uses: actions/checkout@v3
2814

29-
- name: Overriding default $CARGO_PROJECT_NAME with matrix value
30-
if: ${{ matrix.cargo_project_name }}
31-
run: echo "CARGO_PROJECT_NAME=${{ matrix.cargo_project_name }}" >> $GITHUB_ENV
32-
3315
- name: Install stable toolchain
3416
uses: actions-rs/toolchain@v1
3517
with:
3618
profile: minimal
3719
toolchain: stable
3820
override: true
3921

40-
- uses: actions/cache@v3
41-
name: Cache Cargo.lock
22+
- name: Rust Cache
23+
uses: Swatinem/rust-cache@v2
4224
with:
43-
path: |
44-
~/.cargo/bin/
45-
~/.cargo/registry/
46-
~/.cargo/git/
47-
target/
48-
key: cargo-doc-${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}-${{ matrix.project }}-${{ hashFiles('Cargo.lock') }}
49-
restore-keys: |
50-
cargo-doc-${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}-${{ matrix.project }}-
51-
cargo-doc-${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}-
52-
53-
- name: Generate ${{ matrix.project }} doc
25+
key: ${{ runner.os }}-cache-v${{ secrets.CACHE_VERSION }}
26+
27+
- name: Generate cargo doc
5428
uses: actions-rs/cargo@v1
5529
with:
5630
command: doc
57-
args: --no-deps -p ${{ env.CARGO_PROJECT_NAME }}
31+
args: --no-deps -p mithril -p mithril-common -p mithril-aggregator -p mithril-signer -p mithril-client
5832

59-
- name: Publish ${{ matrix.project }}-doc
33+
- name: Publish Mithril-rust-doc
6034
uses: actions/upload-artifact@v3
6135
with:
62-
name: ${{ matrix.project }}-doc
36+
name: mithril-rust-doc
6337
if-no-files-found: error
6438
path: |
6539
target/doc/
6640
6741
build-docusaurus:
68-
if: github.event.pull_request.draft == false
6942
runs-on: ubuntu-22.04
7043
steps:
7144
- name: Checkout sources
@@ -148,35 +121,11 @@ jobs:
148121
- build-explorer
149122
- build-open-api-ui
150123
steps:
151-
- name: Download mithril-core-doc artifact
152-
uses: actions/download-artifact@v3
153-
with:
154-
name: mithril-core-doc
155-
path: ./github-pages/mithril-core/doc
156-
157-
- name: Download mithril-common-doc artifact
158-
uses: actions/download-artifact@v3
159-
with:
160-
name: mithril-common-doc
161-
path: ./github-pages/mithril-common/doc
162-
163-
- name: Download aggregator-doc artifact
164-
uses: actions/download-artifact@v3
165-
with:
166-
name: mithril-aggregator-doc
167-
path: ./github-pages/mithril-aggregator/doc
168-
169-
- name: Download client-doc artifact
170-
uses: actions/download-artifact@v3
171-
with:
172-
name: mithril-client-doc
173-
path: ./github-pages/mithril-client/doc
174-
175-
- name: Download signer-doc artifact
124+
- name: Download mithril-rust-doc artifact
176125
uses: actions/download-artifact@v3
177126
with:
178-
name: mithril-signer-doc
179-
path: ./github-pages/mithril-signer/doc
127+
name: mithril-rust-doc
128+
path: ./github-pages/rust-doc
180129

181130
- name: Download Docusaurus build
182131
uses: actions/download-artifact@v3

‎docs/root/manual/developer-docs/references.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ For more information about the **Mithril Protocol**, please refer to the [About
2222

2323
| Dependency | Description | Source Repository | Rust Documentation | REST API
2424
|------------|-------------|:-----------------:|:------------------:|:------------:|
25-
| **Mithril Common** | This is the **common** library that is used by the **Mithril Network** nodes. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-common) | [:arrow_upper_right:](https://mithril.network/mithril-common/doc/mithril_common/index.html) | -
26-
| **Mithril Core** | The **core** library that implements **Mithril** protocol cryptographic engine. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-core) | [:arrow_upper_right:](https://mithril.network/mithril-core/doc/mithril/index.html) | -
27-
| **Mithril Aggregator** | The node of the **Mithril Network** responsible for collecting individual signatures from the **Mithril Signers** and aggregate them into a multisignature. The **Mithril Aggregator** uses this ability to provide certified snapshots of the **Cardano** blockchain. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-aggregator) | [:arrow_upper_right:](https://mithril.network/mithril-aggregator/doc/mithril_aggregator/index.html) | [:arrow_upper_right:](/aggregator-api)
28-
| **Mithril Client** | The node of the **Mithril Network** responsible for restoring the **Cardano** blockchain on an empty node from a certified snapshot. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-client) | [:arrow_upper_right:](https://mithril.network/mithril-client/doc/mithril_client/index.html) | -
29-
| **Mithril Signer** | The node of the **Mithril Network** responsible for producing individual signatures that are collected and aggregated by the **Mithril Aggregator**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-signer) | [:arrow_upper_right:](https://mithril.network/mithril-signer/doc/mithril_signer/index.html) | -
25+
| **Mithril Common** | This is the **common** library that is used by the **Mithril Network** nodes. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-common) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_common/index.html) | -
26+
| **Mithril Core** | The **core** library that implements **Mithril** protocol cryptographic engine. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-core) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril/index.html) | -
27+
| **Mithril Aggregator** | The node of the **Mithril Network** responsible for collecting individual signatures from the **Mithril Signers** and aggregate them into a multisignature. The **Mithril Aggregator** uses this ability to provide certified snapshots of the **Cardano** blockchain. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-aggregator) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_aggregator/index.html) | [:arrow_upper_right:](/aggregator-api)
28+
| **Mithril Client** | The node of the **Mithril Network** responsible for restoring the **Cardano** blockchain on an empty node from a certified snapshot. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-client) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_client/index.html) | -
29+
| **Mithril Signer** | The node of the **Mithril Network** responsible for producing individual signatures that are collected and aggregated by the **Mithril Aggregator**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-signer) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_signer/index.html) | -
3030
| **Mithril Devnet** | The private **Mithril/Cardano Network** used to scaffold a **Mithril Network** on top of a private **Cardano Network**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-test-lab/mithril-devnet) | - | -
3131
| **Mithril End to End** | The tool used to run tests scenari against a **Mithril Devnet**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-explorer) | - | -
3232
| **Mithril Explorer** | The explorer website that connects to a **Mithril Aggregator** and displays its **Certificate Chain**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-test-lab/mithril-end-to-end) | - | -

0 commit comments

Comments
 (0)