Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Commit 8261f30

Browse files
committed
mark crate and entire functionality as deprecated and obsolete
1 parent dd050fa commit 8261f30

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

Cargo.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,5 @@ env_logger = "0.10"
3535
rpassword = "7"
3636
tokio = { version = "1.14.0", features = ["macros", "rt-multi-thread"] }
3737

38+
[badges]
39+
maintenance = { status = "deprecated" }

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,18 @@
1-
# base library for interacting with Fedora services
1+
# base library for interacting with Fedora services (DEPRECATED)
22

33
[![crates.io](https://img.shields.io/crates/v/fedora.svg)](https://crates.io/crates/fedora/)
44
[![crates.io](https://img.shields.io/crates/d/fedora.svg)](https://crates.io/crates/fedora/)
55
[![crates.io](https://img.shields.io/crates/l/fedora.svg)](https://crates.io/crates/fedora/)
66
[![docs.rs](https://docs.rs/fedora/badge.svg)](https://docs.rs/fedora/)
77

8-
This crate provides a base for interacting with Fedora web services.
9-
10-
It is intended to provide functionality similar to the [`fedora`][fedora.py]
11-
Python package, but for Rust.
12-
13-
Refer to the docs on [docs.rs] for a complete description of the functionality
14-
of this crate.
15-
16-
[docs.rs]: https://docs.rs/fedora
17-
[fedora.py]: https://github.com/fedora-infra/python-fedora
18-
19-
## DONE
20-
21-
- OpenID authentication
22-
23-
## TODO
24-
25-
- authenticating with OpenID Connect
26-
- authenticating for FAS2, wiki
27-
8+
**WARNING**: The OpenID-based authentication method for Fedora web services that
9+
was provided by this crate no longer works. Most web services that are part of
10+
the Fedora Project have moved to OpenID Connect (OIDC) or Kerberos-based
11+
authentication. Bodhi was one of the last services that provided a deprecated
12+
OpenID authentication endpoint, but that endpoint was accidentally broken in
13+
bodhi-server v8.0.0 and can likely not be fixed. That makes the `fedora` crate
14+
obsolete.
15+
16+
If another project that is related with the Fedora Project wants to use the "fedora"
17+
name to publish on crates.io, transfer of ownership of the name can be discussed.
18+
Please open a ticket on GitHub in this case.

src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
#![warn(missing_debug_implementations)]
99
#![warn(clippy::unwrap_used)]
1010

11+
#![deprecated(
12+
note = "The \"fedora\" crate is obsolete.
13+
The OpenID-based authentication method for Fedora web services provided by this crate no longer works.
14+
There is currently no known replacement.",
15+
since = "2.1.2",
16+
)]
17+
1118
use std::time::Duration;
1219

1320
/// default value of the User-Agent HTTP header: `fedora-rs v$CARGO_PKG_VERSION`

0 commit comments

Comments
 (0)