Skip to content

Commit

Permalink
Fix intra-doc links on docs.rs (#1205)
Browse files Browse the repository at this point in the history
* Use version 2 of Cargo's feature resolver

* Increase minimum version of tungstenite

Tungstenite 0.17.1 has a higher MSRV, and there should be no reason to
use it over 0.17.2.

* Clean up and fix MSRV CI job

* Fix some intra-doc links not resolving correctly on docs.rs

* Bump minimum version of tower

… to avoid dependencies with a broken minimum-versions chain.
  • Loading branch information
jplatte authored and davidpdrsn committed Oct 20, 2022
1 parent 7d74086 commit f424c9d
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 27 deletions.
10 changes: 7 additions & 3 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: CI

env:
CARGO_TERM_COLOR: always
MSRV: 1.56.0
MSRV: 1.56

on:
push:
Expand Down Expand Up @@ -113,6 +113,12 @@ jobs:
command: update
args: -Z minimal-versions
toolchain: nightly
- name: Fix up Cargo.lock
uses: actions-rs/cargo@v1
with:
command: update
args: -p crc32fast --precise 1.1.1
toolchain: nightly
- name: Run tests
uses: actions-rs/cargo@v1
with:
Expand All @@ -121,7 +127,6 @@ jobs:
-p axum
-p axum-extra
-p axum-core
-p internal-minimal-versions
--all-features
--all-targets
--locked
Expand All @@ -135,7 +140,6 @@ jobs:
command: test
args: >
-p axum-macros
-p internal-minimal-versions
--doc
--all-features
--locked
Expand Down
6 changes: 1 addition & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,5 @@ members = [
"axum-core",
"axum-extra",
"axum-macros",

# internal crate used to bump the minimum versions we
# get for some dependencies which otherwise wouldn't build
# with `cargo +nightly update -Z minimal-versions`
"internal-minimal-versions",
]
resolver = "2"
7 changes: 5 additions & 2 deletions axum/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ query = ["serde_urlencoded"]
tower-log = ["tower/log"]
ws = ["tokio-tungstenite", "sha-1", "base64"]

# Required for intra-doc links to resolve correctly
__private_docs = ["tower/full", "tower-http/full"]

[dependencies]
async-trait = "0.1.43"
axum-core = { path = "../axum-core", version = "0.2.8" }
Expand All @@ -42,7 +45,7 @@ pin-project-lite = "0.2.7"
serde = "1.0"
sync_wrapper = "0.1.1"
tokio = { version = "1", features = ["time"] }
tower = { version = "0.4.11", default-features = false, features = ["util", "make"] }
tower = { version = "0.4.13", default-features = false, features = ["util", "make"] }
tower-http = { version = "0.3.0", features = ["util", "map-response-body"] }
tower-layer = "0.3"
tower-service = "0.3"
Expand All @@ -55,7 +58,7 @@ multer = { version = "2.0.0", optional = true }
serde_json = { version = "1.0", features = ["raw_value"], optional = true }
serde_urlencoded = { version = "0.7", optional = true }
sha-1 = { version = "0.10", optional = true }
tokio-tungstenite = { version = "0.17", optional = true }
tokio-tungstenite = { version = "0.17.2", optional = true }

[dev-dependencies]
anyhow = "1.0"
Expand Down
1 change: 1 addition & 0 deletions examples/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[workspace]
members = ["*"]
exclude = ["target"]
resolver = "2"
16 changes: 0 additions & 16 deletions internal-minimal-versions/Cargo.toml

This file was deleted.

1 change: 0 additions & 1 deletion internal-minimal-versions/src/lib.rs

This file was deleted.

0 comments on commit f424c9d

Please sign in to comment.