# `VulnCheck.Report.GitHub`
[🔗](https://github.com/Voskan/vulncheck/blob/v1.0.1/lib/vulncheck/report/ci.ex#L1)

GitHub Actions report (`--format github`).

Prints workflow commands that GitHub turns into pull request annotations:
`::error` for reachable findings, `::warning` for potentially reachable
findings and retired releases (`::notice` for unreachable ones with
`--show-unreachable`). When `GITHUB_STEP_SUMMARY` is set, the Markdown
report is appended to the job summary as well.

# `data`

```elixir
@spec data(String.t()) :: String.t()
```

Escapes workflow command data.

    iex> VulnCheck.Report.GitHub.data("50% done\nnext")
    "50%25 done%0Anext"

# `property`

```elixir
@spec property(String.t()) :: String.t()
```

Escapes a workflow command property value.

    iex> VulnCheck.Report.GitHub.property("a:b,c")
    "a%3Ab%2Cc"

# `write_step_summary`

```elixir
@spec write_step_summary(VulnCheck.Types.ScanReport.t(), VulnCheck.Config.t()) ::
  :ok | {:error, File.posix()}
```

Appends the Markdown report to the file named by `GITHUB_STEP_SUMMARY`.
Does nothing when the variable is unset.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
