Skip to content

Commit bf32aef

Browse files
authored
Merge pull request yegor256#276 from owtotwo/master
Some CI improvements, remove unnecessary content, add `docs` ci to .workflow .
2 parents add284f + a8a96fa commit bf32aef

File tree

6 files changed

+39
-11
lines changed

6 files changed

+39
-11
lines changed

.github/workflows/cargo.yml

+7-9
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,15 @@ jobs:
1313
build:
1414
timeout-minutes: 15
1515
runs-on: ubuntu-24.04
16+
env:
17+
CARGO_TERM_COLOR: always
1618
steps:
1719
- uses: actions/checkout@v4
18-
- uses: actions/setup-java@v4
19-
with:
20-
distribution: 'temurin'
21-
java-version: 17
2220
- uses: actions-rs/toolchain@v1
2321
with:
2422
toolchain: stable
25-
- run: cargo --color=never test --all-features -vv -- --nocapture
26-
- run: cargo --color=never test --release --all-features -vv -- --nocapture
27-
- run: cargo --color=never fmt --check
28-
- run: cargo --color=never doc --no-deps
29-
- run: cargo --color=never clippy -- --no-deps
23+
- run: cargo test --all-features -- --show-output
24+
- run: cargo test --release --all-features -- --show-output
25+
- run: cargo fmt --check
26+
- run: cargo doc --no-deps
27+
- run: cargo clippy -- --no-deps

.github/workflows/docs.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2023-2025 Yegor Bugayenko
2+
# SPDX-FileCopyrightText: Copyright (c) 2025 owtotwo
3+
# SPDX-License-Identifier: MIT
4+
---
5+
# yamllint disable rule:line-length
6+
name: docs
7+
'on':
8+
push:
9+
pull_request:
10+
jobs:
11+
build:
12+
timeout-minutes: 15
13+
runs-on: ubuntu-24.04
14+
env:
15+
CARGO_TERM_COLOR: always
16+
RUSTDOCFLAGS: '--cfg docsrs'
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions-rs/toolchain@v1
20+
with:
21+
toolchain: nightly
22+
- run: cargo +nightly test --doc --all-features -- --show-output
23+
- run: cargo +nightly doc --all-features --no-deps

.github/workflows/examples.yml

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ jobs:
1111
run-examples:
1212
timeout-minutes: 15
1313
runs-on: ubuntu-24.04
14+
env:
15+
CARGO_TERM_COLOR: always
1416
steps:
1517
- uses: actions/checkout@v4
1618
- uses: actions-rs/toolchain@v1

.github/workflows/markdown-lint.yml

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ name: markdown-lint
77
push:
88
branches:
99
- master
10+
- dev
1011
pull_request:
1112
branches:
1213
- master

.github/workflows/tarpaulin.yml

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ name: tarpaulin
77
push:
88
branches:
99
- master
10+
- dev
1011
jobs:
1112
tarpaulin:
1213
timeout-minutes: 15

src/lib.rs

+5-2
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,18 @@
2626
//! will have exactly ten elements. An attempt to add an 11th element will lead
2727
//! to a panic.
2828
29-
#![cfg_attr(docsrs, feature(doc_cfg))]
3029
#![cfg_attr(all(not(feature = "std"), not(doc), not(test)), no_std)]
3130
#![doc(html_root_url = "https://docs.rs/micromap/0.0.0")]
3231
#![deny(warnings)]
3332
#![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
3433
#![warn(rust_2018_idioms)]
35-
// #![warn(missing_docs)]
34+
// About the docs
35+
#![cfg_attr(docsrs, feature(doc_cfg))]
3636
#![cfg_attr(docsrs, feature(rustdoc_missing_doc_code_examples))]
3737
#![warn(rustdoc::missing_crate_level_docs)]
38+
// Our Goal, uncomment these!
39+
// #![warn(missing_docs)]
40+
// #![doc(test(attr(deny(unused))))]
3841
#![doc(test(attr(warn(unused))))]
3942

4043
mod clone;

0 commit comments

Comments
 (0)