Skip to content

Commit

Permalink
Bringing supported languages to its own page
Browse files Browse the repository at this point in the history
Signed-off-by: Hayley Denbraver <[email protected]>
  • Loading branch information
Hayley Denbraver committed Nov 10, 2023
1 parent 6b96f89 commit 13eb328
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: Configuration
permalink: /configuration/
nav_order: 4
nav_order: 5
---
# Configure OSV-Scanner

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: Contribute
permalink: /contribute/
nav_order: 8
nav_order: 9
---
# Contribute

Expand Down
2 changes: 1 addition & 1 deletion docs/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: Experimental Features
permalink: /experimental/
nav_order: 7
nav_order: 8
---
# Experimental Features

Expand Down
2 changes: 1 addition & 1 deletion docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: GitHub Action
permalink: /github-action/
nav_order: 6
nav_order: 7
---

# GitHub Action
Expand Down
16 changes: 1 addition & 15 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,4 @@ OSV-Scanner provides an officially supported frontend to the [OSV database](http

The above all results in fewer, more actionable vulnerability notifications, which reduces the time needed to resolve them. Check out our [announcement blog post] for more details!

[announcement blog post]: https://security.googleblog.com/2022/12/announcing-osv-scanner-vulnerability.html

## Supported languages and lockfiles

| Language | Compatible Lockfile(s) |
|:----------:|:-----------------------------------------------------------------------------------------------------------------------------------:|
| Elixir | `mix.lock` |
| C/C++ | `conan.lock` |
| Go | `go.mod` |
| Java | `buildscript-gradle.lockfile`<br>`gradle.lockfile`<br>`pom.xml`[\*](https://github.com/google/osv-scanner/issues/35)<br>`yarn.lock` |
| Javascript | `package-lock.json`<br>`packages.lock.json` |
| PHP | `composer.lock` |
| Python | `Pipfile.lock`<br>`poetry.lock`<br>`requirements.txt`[\*](https://github.com/google/osv-scanner/issues/34) |
| Ruby | `Gemfile.lock` |
| Rust | `Cargo.lock`
[announcement blog post]: https://security.googleblog.com/2022/12/announcing-osv-scanner-vulnerability.html
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: Installation
permalink: /installation/
nav_order: 2
nav_order: 3
---

# Installation
Expand Down
2 changes: 1 addition & 1 deletion docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: Output
permalink: /output/
nav_order: 5
nav_order: 6
---
# Output
{: .no_toc }
Expand Down
20 changes: 20 additions & 0 deletions docs/supported_languages_and_lockfiles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: page
title: Supported Languages and Lockfiles
permalink: /supported-languages-and-lockfiles/
nav_order: 2
---

# Supported Languages and Lockfiles

| Language | Compatible Lockfile(s) |
|:-----------|:------------------|
| Elixir | `mix.lock` |
| C/C++ | `conan.lock`|
| Go | `go.mod` |
| Java | `buildscript-gradle.lockfile`<br>`gradle.lockfile`<br>`pom.xml`[\*](https://github.com/google/osv-scanner/issues/35)<br>`yarn.lock` |
| Javascript | `package-lock.json`<br>`packages.lock.json`|
| PHP | `composer.lock`|
| Python | `Pipfile.lock`<br>`poetry.lock`<br>`requirements.txt`[\*](https://github.com/google/osv-scanner/issues/34) |
| Ruby | `Gemfile.lock`|
| Rust | `Cargo.lock`|
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: Usage
permalink: /usage/
nav_order: 3
nav_order: 4
---
# Usage

Expand Down

0 comments on commit 13eb328

Please sign in to comment.