mirror of
https://github.com/saymrwulf/curve25519-dalek-source.git
synced 2026-09-08 21:00:40 +00:00
Fix docs build and prep prerelease (#855)
* Fix failing docs build * Remove hiding of docsrs cfg gate in crates where it doesn't appear * Add docsrs build regression check to CI
This commit is contained in:
Michael Rosenberg
GitHub
parent
f8481d94d5
commit
3d76df7c24
14 changed files with 33 additions and 33 deletions
10
.github/workflows/workspace.yml
vendored
10
.github/workflows/workspace.yml
vendored
|
|
@ -110,6 +110,16 @@ jobs:
|
|||
toolchain: stable
|
||||
- run: cargo doc --all-features
|
||||
|
||||
docsrs:
|
||||
name: Check docs-rs build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: dtolnay/rust-toolchain@nightly
|
||||
- run: cargo doc --all-features --no-deps
|
||||
env:
|
||||
RUSTDOCFLAGS: '--cfg docsrs'
|
||||
|
||||
typos:
|
||||
name: Check for typos
|
||||
runs-on: ubuntu-latest
|
||||
|
|
|
|||
|
|
@ -5,9 +5,9 @@ major series.
|
|||
|
||||
## 5.x series
|
||||
|
||||
## 5.0.0-pre.2
|
||||
## 5.0.0-pre.3
|
||||
|
||||
* Add Lizard bytes-to-point injection for Ristretto. Gated under `lizard`.
|
||||
* Add Lizard bytes-to-point injection for Ristretto. Gated under `lizard` feature.
|
||||
* Upgrade `rand_core` to v0.10.0-rc-2
|
||||
|
||||
## 5.0.0-pre.1
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ name = "curve25519-dalek"
|
|||
# - update CHANGELOG
|
||||
# - update README if required by semver
|
||||
# - if README was updated, also update module documentation in src/lib.rs
|
||||
version = "5.0.0-pre.2"
|
||||
version = "5.0.0-pre.3"
|
||||
edition = "2024"
|
||||
rust-version = "1.85.0"
|
||||
authors = [
|
||||
|
|
@ -28,13 +28,7 @@ rustdoc-args = [
|
|||
"--cfg",
|
||||
"docsrs",
|
||||
]
|
||||
features = [
|
||||
"serde",
|
||||
"rand_core",
|
||||
"digest",
|
||||
"legacy_compatibility",
|
||||
"group-bits",
|
||||
]
|
||||
all-features = true
|
||||
|
||||
[dev-dependencies]
|
||||
sha2 = { version = "0.11.0-rc.3", default-features = false }
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ cofactor-related abstraction mismatches.
|
|||
To import `curve25519-dalek`, add the following to the dependencies section of
|
||||
your project's `Cargo.toml`:
|
||||
```toml
|
||||
curve25519-dalek = "5.0.0-pre.1"
|
||||
curve25519-dalek = "5.0.0-pre.3"
|
||||
```
|
||||
|
||||
If opting into [SemVer-exempted features](#public-api-semver-exemptions) a range
|
||||
|
|
|
|||
|
|
@ -10,8 +10,8 @@
|
|||
// - Henry de Valence <hdevalence@hdevalence.ca>
|
||||
|
||||
#![no_std]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg, doc_cfg_hide))]
|
||||
#![cfg_attr(docsrs, doc(cfg_hide(docsrs)))]
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
#![cfg_attr(docsrs, doc(auto_cfg(hide(docsrs))))]
|
||||
//------------------------------------------------------------------------
|
||||
// Documentation:
|
||||
//------------------------------------------------------------------------
|
||||
|
|
@ -92,7 +92,7 @@ pub(crate) mod backend;
|
|||
pub(crate) mod window;
|
||||
|
||||
#[cfg(feature = "lizard")]
|
||||
pub mod lizard;
|
||||
mod lizard;
|
||||
|
||||
pub use crate::{
|
||||
edwards::EdwardsPoint, montgomery::MontgomeryPoint, ristretto::RistrettoPoint, scalar::Scalar,
|
||||
|
|
|
|||
|
|
@ -1,7 +1,5 @@
|
|||
//! The Lizard method for encoding/decoding 16 bytes into Ristretto points.
|
||||
|
||||
#![allow(non_snake_case)]
|
||||
|
||||
#[cfg(curve25519_dalek_bits = "32")]
|
||||
mod u32_constants;
|
||||
|
||||
|
|
@ -10,4 +8,4 @@ mod u64_constants;
|
|||
|
||||
mod jacobi_quartic;
|
||||
mod lizard_constants;
|
||||
pub mod lizard_ristretto;
|
||||
mod lizard_ristretto;
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Entries are listed in reverse chronological order per undeprecated major series.
|
|||
|
||||
# 3.x series
|
||||
|
||||
## 3.0.0-pre.2
|
||||
## 3.0.0-pre.3
|
||||
|
||||
* Upgrade `rand_core` to v0.10.0-rc-2
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "ed25519-dalek"
|
||||
version = "3.0.0-pre.2"
|
||||
version = "3.0.0-pre.3"
|
||||
edition = "2024"
|
||||
authors = [
|
||||
"isis lovecruft <isis@patternsinthevoid.net>",
|
||||
|
|
@ -25,10 +25,10 @@ rustdoc-args = [
|
|||
"--cfg",
|
||||
"docsrs",
|
||||
]
|
||||
features = ["batch", "digest", "hazmat", "pem", "serde"]
|
||||
all-features = true
|
||||
|
||||
[dependencies]
|
||||
curve25519-dalek = { version = "=5.0.0-pre.2", default-features = false, features = [
|
||||
curve25519-dalek = { version = "=5.0.0-pre.3", default-features = false, features = [
|
||||
"digest",
|
||||
] }
|
||||
ed25519 = { version = "3.0.0-rc.2", default-features = false }
|
||||
|
|
@ -43,11 +43,11 @@ serde = { version = "1.0", default-features = false, optional = true }
|
|||
zeroize = { version = "1.5", default-features = false, optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
curve25519-dalek = { version = "=5.0.0-pre.2", default-features = false, features = [
|
||||
curve25519-dalek = { version = "=5.0.0-pre.3", default-features = false, features = [
|
||||
"digest",
|
||||
"rand_core",
|
||||
] }
|
||||
x25519-dalek = { version = "=3.0.0-pre.2", default-features = false, features = [
|
||||
x25519-dalek = { version = "=3.0.0-pre.3", default-features = false, features = [
|
||||
"static_secrets",
|
||||
] }
|
||||
blake2 = "0.11.0-rc.3"
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ verification.
|
|||
To import `ed25519-dalek`, add the following to the dependencies section of
|
||||
your project's `Cargo.toml`:
|
||||
```toml
|
||||
ed25519-dalek = "3.0.0-pre.0"
|
||||
ed25519-dalek = "3.0.0-pre.3"
|
||||
```
|
||||
|
||||
# Feature Flags
|
||||
|
|
|
|||
|
|
@ -251,8 +251,7 @@
|
|||
#![deny(missing_docs)] // refuse to compile if documentation is missing
|
||||
#![deny(clippy::unwrap_used)] // don't allow unwrap
|
||||
#![cfg_attr(not(any(test, feature = "batch")), forbid(unsafe_code))]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg, doc_cfg_hide))]
|
||||
#![cfg_attr(docsrs, doc(cfg_hide(docsrs)))]
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
|
||||
#[cfg(feature = "batch")]
|
||||
extern crate alloc;
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Entries are listed in reverse chronological order.
|
|||
|
||||
# 3.x Series
|
||||
|
||||
## 3.0.0-pre.2
|
||||
## 3.0.0-pre.3
|
||||
|
||||
* Upgrade `rand_core` to v0.10.0-rc-2
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ edition = "2024"
|
|||
# - update html_root_url
|
||||
# - update CHANGELOG
|
||||
# - if any changes were made to README.md, mirror them in src/lib.rs docs
|
||||
version = "3.0.0-pre.2"
|
||||
version = "3.0.0-pre.3"
|
||||
authors = [
|
||||
"Isis Lovecruft <isis@patternsinthevoid.net>",
|
||||
"DebugSteven <debugsteven@gmail.com>",
|
||||
|
|
@ -39,10 +39,10 @@ rustdoc-args = [
|
|||
"--cfg",
|
||||
"docsrs",
|
||||
]
|
||||
features = ["reusable_secrets", "serde", "static_secrets"]
|
||||
all-features = true
|
||||
|
||||
[dependencies]
|
||||
curve25519-dalek = { version = "=5.0.0-pre.2", default-features = false }
|
||||
curve25519-dalek = { version = "=5.0.0-pre.3", default-features = false }
|
||||
rand_core = { version = "0.10.0-rc-2", default-features = false }
|
||||
|
||||
# optional dependencies
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ To install, add the following to your project's `Cargo.toml`:
|
|||
|
||||
```toml
|
||||
[dependencies]
|
||||
x25519-dalek = "3.0.0-pre.0"
|
||||
x25519-dalek = "3.0.0-pre.3"
|
||||
```
|
||||
|
||||
# MSRV
|
||||
|
|
|
|||
|
|
@ -15,8 +15,7 @@
|
|||
// README.md as the crate documentation.
|
||||
|
||||
#![no_std]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg, doc_cfg_hide))]
|
||||
#![cfg_attr(docsrs, doc(cfg_hide(docsrs)))]
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
#![deny(missing_docs)]
|
||||
#![doc(
|
||||
html_logo_url = "https://cdn.jsdelivr.net/gh/dalek-cryptography/curve25519-dalek/docs/assets/dalek-logo-clear.png"
|
||||
|
|
|
|||
Loading…
Reference in a new issue