An open API service indexing awesome lists of open source software.

https://github.com/getappmap/scanner-demo


https://github.com/getappmap/scanner-demo

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          

# scanner-demo

Runs AppMap scanners on sample projects, and uploads the output data to [Google Cloud Storage](https://console.cloud.google.com/storage/browser/appland-ci-artifacts/scanner-demo/main).

Note that artifacts are **only uploaded from builds of the main branch**. This is a Travis limitation for security purposes.

# Artifacts

Each artifact is a tar-gzip (tarball), so that all the data can be downloaded as one unit.

* `[project].findings.tgz` Scanner findings in JSON, plus AppMap file for each finding.
* `[project].appmaps.tgz` All AppMaps generated for the project by the build. This may be a subset of all the project tests, depending on how the build is run.

# Updating scanners

1. Update `@applandinc/scanners` in [package.json](https://github.com/applandinc/scanner-demo/blob/main/package.json).
2. Merge/commit to `main` (because artifacts aren't uploaded unless the build is on `main`).

# Adding a project

Clone the new project as a Git submodule.

Configure .travis.yml to build the project.