diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index e336bc7..558cc27 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -100,7 +100,7 @@ jobs: # https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability strategy: matrix: - msrv: ["1.63.0"] # 2021 edition requires 1.56 + msrv: ["1.70.0"] # 2021 edition requires 1.56 name: ubuntu / ${{ matrix.msrv }} steps: - uses: actions/checkout@v4 diff --git a/Cargo.toml b/Cargo.toml index c9b4147..dfd4f44 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ license = "MIT" include = ["src/**/*.rs", "LICENSE", "*.md", "example/**/*", "Cargo.toml"] repository = "https://github.com/spraakbanken/webcrawler-rs" homepage = "https://spraakbanken.gu.se" -rust-version = "1.63.0" # MSRV +rust-version = "1.70.0" # MSRV # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [lib] diff --git a/README.md b/README.md index 6310cd3..a85a2c4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ # webcrawler-rs Library for building a webcrawlers + +[![MIT licensed][mit-badge]][mit-url] + +[![Maturity badge - level 1][scorecard-badge]][scorecard-url] + +[![CI(check)][actions-check-badge]][actions-check-url] +[![CI(scheduled)][actions-scheduled-badge]][actions-scheduled-url] +[![CI(test)][actions-test-badge]][actions-test-url] + +[crates-badge]: https://img.shields.io/crates/v/mio.svg +[crates-url]: https://crates.io/crates/mio +[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg +[mit-url]: LICENSE +[actions-check-badge]: https://github.com/spraakbanken/webcrawler-rs/actions/workflows/check.yml/badge.svg +[actions-check-url]: https://github.com/spraakbanken/webcrawler-rs/actions?query=workflow%3Acheck+branch%3Amain +[actions-scheduled-badge]: https://github.com/spraakbanken/webcrawler-rs/actions/workflows/scheduled.yml/badge.svg +[actions-scheduled-url]: https://github.com/spraakbanken/webcrawler-rs/actions?query=workflow%3Ascheduled+branch%3Amain +[actions-test-badge]: https://github.com/spraakbanken/webcrawler-rs/actions/workflows/test.yml/badge.svg +[actions-test-url]: https://github.com/spraakbanken/webcrawler-rs/actions?query=workflow%3Atest+branch%3Amain +[scorecard-badge]: https://img.shields.io/badge/Maturity-Level%201%20--%20New%20Project-yellow.svg +[scorecard-url]: https://github.com/spraakbanken/getting-started/blob/main/scorecard.md + +## MSRV Policy + +The MSRV (Minimum Supported Rust Version) is fixed for a given minor (1.x) +version. However it can be increased when bumping minor versions, i.e. going +from 1.0 to 1.1 allows us to increase the MSRV. Users unable to increase their +Rust version can use an older minor version instead. Below is a list of webcrawler versions +and their MSRV: + + * v0.1: Rust 1.70. + +Note however that webcrawler also has dependencies, which might have different MSRV +policies. We try to stick to the above policy when updating dependencies, but +this is not always possible. diff --git a/examples/Cargo.toml b/examples/Cargo.toml index 37ab2f8..a625ab8 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -10,6 +10,6 @@ path = "src/fake_crawler/main.rs" [dependencies] async-trait = "0.1.82" -tokio = { version = "1.40.0", features = ["rt-multi-thread", "macros"] } +tokio = { version = "1.31", features = ["rt-multi-thread", "macros"] } tracing-subscriber = { version = "0.3.18", features = ["env-filter"] } -webcrawler = { version = "0.1.0", path = ".." } +webcrawler = { path = ".." }