mirror of https://github.com/deps-rs/deps.rs.git synced 2024-11-21 18:06:30 +00:00

valentinleistner ba7647dcff

deps.rs is now available for self-hosted Gitea at
`/repo/gitea/<DOMAIN>/owner/repo`, e. g.
`/repo/gitea/git.example.org/deps-rs/deps.rs`,
`/repo/gitea/git.example.org:1234/deps-rs/deps.rs`,
`/repo/gitea/http://unsafe-gitea.org/deps-rs/deps.rs`.

This _should_ also include support for Gitea hosted in subdirectories,
e. g. `www.example.org/gitea`, though I haven't tested this yet.

If no protocol (`https://`/`http://`) is specified, `https://` is
automatically added to the beginning of the gitea server's URL.
However I could also change this to only accept https. Another
option might be the use of URL-encoding.
I am open for feedback, feel free to suggest changes.

Implementation notes:

- The Router now matches `/repo/*site/:qual/:name` instead of
  `/repo/:site/:qual/:name` to allow for an arbitrary number of
  `/`s before qual and name.
- `RepoSite` now has a new variant `Gitea(GiteaDomain)`.
- `RepoSite` no longer implements `Copy`. However this should not
  be problematic because `Copy`ing was only used for `to_base_uri`,
  `to_usercontent_base_uri` and `to_usercontent_repo_suffix` which
  now accept `&self` references.
- `RepoSite` no longer implements `AsRef` and now uses `Display`
  instead.

- updated test `correct_raw_url_generation`
- updated readme

Related to #84, #141

2022-08-21 11:16:52 +02:00

2.7 KiB

Raw Permalink Blame History

Deps.rs - Dependency status at a glance

Deps.rs is a service that shows you at a glance if any of your dependencies are out of date or insecure. This works by comparing the dependencies in a project's Cargo.toml to the latest versions in the crates.io database. For security-related information, we query the RustSec Security Advisory Database.

We currently support projects and crates hosted on crates.io, Github, Gitlab, Bitbucket, and SourceHut. To analyze the state of your dependencies you can use the following URLs:

for projects on crates.io: https://deps.rs/crate/<NAME>
for projects on Github, Gitlab, Bitbucket, SourceHut, Codeberg, or Gitea: https://deps.rs/repo/<HOSTER>/<USER>/<REPO> (where <HOSTER> is either github, gitlab, bitbucket, sourcehut, codeberg, or gitea/<DOMAIN>)

Badges

On the analysis page, you will also find the markdown code to include a fancy badge in your project README so visitors (and you) can see at a glance if your dependencies are still up to date!

Badges have a few style options, specified with query parameters, that match the styles from shields.io:

?style=flat (default)
?style=flat-square
?style=for-the-badge

Contributing

We are always looking for help from the community! Feel like a feature is missing? Found a bug? Open an issue!

Do you want to contribute? Then browse the list of open issues and ask if you can take care of it.

Building the project

To get started on the project simply clone the repository and run the build:

git clone https://github.com/deps-rs/deps.rs
cd deps.rs
cargo run

The started development server will listen on port 8080 on localhost, so you just have to point your browser to http://localhost:8080 to see if it works.

Copyright and License

Licensed under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.