Skip to content

Commit

Permalink
Lint markdown files
Browse files Browse the repository at this point in the history
Becuase they've *alread* got lint issues since PR google#100
  • Loading branch information
wolf99 committed Jan 12, 2023
1 parent 8791c0e commit 217d6ec
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 17 deletions.
12 changes: 5 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
v1.1.0:
===
# Changelog

## v1.1.0

This update adds support for NuGet ecosystem and various bug fixes by the community.

Expand All @@ -10,17 +11,14 @@ This update adds support for NuGet ecosystem and various bug fixes by the commun
- [Bug #131](https://github.com/google/osv-scanner/pull/131): Fix table highlighting overflow.
- [Bug #101](https://github.com/google/osv-scanner/issues/101): Now supports 32 bit systems.


v1.0.2
===
## v1.0.2

This is a minor patch release to mitigate human readable output issues on narrow terminals (#85).

- [Bug #85](https://github.com/google/osv-scanner/issues/85): Better support for narrow terminals.

## v1.0.1

v1.0.1
===
Various bug fixes and improvements. Many thanks to the amazing contributions and suggestions from the community!

- Feature: ARM64 builds are now also available!
Expand Down
21 changes: 14 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ This project follows
## Contributing code

### Prerequisites

Install:

1. [Go](https://go.dev/) 1.18+, use `go version` to check.
2. [GoReleaser](https://goreleaser.com/) (Optional, only if you want reproducible builds).

Expand All @@ -39,16 +41,19 @@ Install:
#### Build using only `go`

Run the following in the project directory:
```shell
$ go build ./cmd/osv-scanner/

```console
go build ./cmd/osv-scanner/
```

Produces `osv-scanner` binary in the project directory.

#### Build using `goreleaser`

Run the following in the project directory:
```shell
$ goreleaser build --rm-dist --single-target --snapshot

```console
goreleaser build --rm-dist --single-target --snapshot
```

See GoReleaser [documentation](https://goreleaser.com/cmd/goreleaser_build/) for build options.
Expand All @@ -59,13 +64,15 @@ using the same Go version as the one used during the actual release (see gorelea
### Running tests

To run tests:
```shell

```console
./run_tests.sh
```

### Linting

To lint your code, run

```shell
```console
./run_lints.sh
```
```
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ brew install osv-scanner
```

If you're a Arch Linux User, you can install osv-scanner from the official repo:
```

```console
pacman -S osv-scanner
```

Expand Down Expand Up @@ -147,7 +148,7 @@ A wide range of lockfiles are supported by utilizing this [lockfile package](htt
#### Example

```console
$ osv-scanner --lockfile=/path/to/your/package-lock.json --lockfile=/path/to/another/Cargo.lock
osv-scanner --lockfile=/path/to/your/package-lock.json --lockfile=/path/to/another/Cargo.lock
```

### Scanning a Debian based docker image packages (preview)
Expand Down Expand Up @@ -212,6 +213,7 @@ reason = "No external http servers are written in Go lang."
```

## JSON output

By default osv-scanner outputs a human readable table. To have osv-scanner output JSON instead, pass the `--json` flag when calling osv-scanner.

When using the --json flag, only the JSON output will be printed to stdout, with all other outputs being directed to stderr. So to save only the json output to file, you can redirect the output with `osv-scanner --json ... > /path/to/file.json`
Expand Down Expand Up @@ -310,13 +312,13 @@ When using the --json flag, only the JSON output will be printed to stdout, with
## Contribute

### Report Problems

If you have what looks like a bug, please use the [Github issue tracking system](https://github.com/google/osv-scanner/issues). Before you file an issue, please search existing issues to see if your issue is already covered.

### Contributing code to `osv-scanner`

See [CONTRIBUTING.md](CONTRIBUTING.md) for documentation on how to contribute code.


## Stargazers over time

[![Stargazers over time](https://starchart.cc/google/osv-scanner.svg)](https://starchart.cc/google/osv-scanner)

0 comments on commit 217d6ec

Please sign in to comment.