mirror of
https://github.com/seemueller-io/hyper-custom-cert.git
synced 2025-09-08 22:46:45 +00:00
remove optional checks in docs workflow, bump version to 0.1.8
This commit is contained in:
79
.github/workflows/docs.yml
vendored
79
.github/workflows/docs.yml
vendored
@@ -73,81 +73,4 @@ jobs:
|
||||
if [ "${{ matrix.no-default-features }}" = "true" ]; then FLAGS="$FLAGS --no-default-features"; fi
|
||||
if [ -n "${{ matrix.features }}" ]; then FLAGS="$FLAGS --features ${{ matrix.features }}"; fi
|
||||
echo "Running: cargo test --doc $FLAGS"
|
||||
cargo test --doc $FLAGS
|
||||
|
||||
readme-sync:
|
||||
name: Check README synchronization
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/bin/
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
target/
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
|
||||
- name: Setup Rust
|
||||
run: rustup update stable && rustup default stable
|
||||
|
||||
|
||||
- name: Install cargo-readme
|
||||
run: cargo install cargo-readme
|
||||
|
||||
- name: Check README is up to date
|
||||
working-directory: crates/hyper-custom-cert
|
||||
run: |
|
||||
# Generate README from lib.rs documentation
|
||||
cargo readme > README_generated.md
|
||||
|
||||
# Compare with existing README
|
||||
if ! diff -u README.md README_generated.md; then
|
||||
echo "ERROR: README.md is not synchronized with lib.rs documentation"
|
||||
echo "Run 'cargo readme > README.md' in crates/hyper-custom-cert/ to update"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Clean up
|
||||
rm README_generated.md
|
||||
|
||||
link-check:
|
||||
name: Check documentation links
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/bin/
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
target/
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
|
||||
- name: Setup Rust
|
||||
run: rustup update stable && rustup default stable
|
||||
|
||||
- name: Build documentation
|
||||
working-directory: crates/hyper-custom-cert
|
||||
run: cargo doc --all-features --no-deps
|
||||
|
||||
- name: Install lychee
|
||||
run: |
|
||||
curl -sSL https://github.com/lycheeverse/lychee/releases/latest/download/lychee-x86_64-unknown-linux-gnu.tar.gz | tar xz
|
||||
sudo mv lychee /usr/local/bin/
|
||||
|
||||
- name: Check links in documentation
|
||||
run: |
|
||||
# Check links in generated documentation
|
||||
lychee 'crates/hyper-custom-cert/target/doc/**/*.html' --exclude-path target --base crates/hyper-custom-cert/target/doc
|
||||
|
||||
# Check links in README files
|
||||
lychee README.md crates/hyper-custom-cert/README.md
|
||||
cargo test --doc $FLAGS
|
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "hyper-custom-cert"
|
||||
version = "0.1.7"
|
||||
version = "0.1.8"
|
||||
edition = "2021"
|
||||
description = "A small, ergonomic HTTP client wrapper around hyper with optional support for custom Root CAs and a dev-only insecure mode for self-signed certificates."
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
Reference in New Issue
Block a user