Skip to content

Commit

Permalink
Update naming
Browse files Browse the repository at this point in the history
  • Loading branch information
eoftedal committed Feb 15, 2024
1 parent 2e429aa commit 81fd239
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/publish-container.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ jobs:

- name: 'Build Inventory Image'
run: |
docker build . --tag ghcr.io/retirejs/retire-scanner:latest
docker push ghcr.io/retirejs/retire-scanner:latest
docker build . --tag ghcr.io/retirejs/retire-site-scanner:latest
docker push ghcr.io/retirejs/retire-site-scanner:latest
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 1.0.3

Renaming from retire-scanner to retire-site-scanner as name was taken

## 1.0.2

Fixing build script
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# retire-scanner
# retire-site-scanner

Scans a URL and looks for JavaScript libraries with known vulnerabilities using retire.js. Can also produce a partial SBOM for the site.

Expand All @@ -22,15 +22,15 @@ npm run start -- <url> [-v] [--sbom]
```
git clone [email protected]:RetireJS/retire-scanner.git
cd retire-scanner
docker build -t retire-scanner .
docker build -t retire-site-scanner .
```
**Scanning**
```
docker run --rm retire-scanner [-v] [--sbom]
docker run --rm retire-site-scanner [-v] [--sbom]
```

## SBOM support

`retire-scanner` can generate a partial SBOM in the CycloneDX v1.4 format. This cannot be considered a complete SBOM for the web site, as it cannot necessarily detect all technologies in use, but can be used as a partial SBOM listing libraries and services.
`retire-site-scanner` can generate a partial SBOM in the CycloneDX v1.4 format. This cannot be considered a complete SBOM for the web site, as it cannot necessarily detect all technologies in use, but can be used as a partial SBOM listing libraries and services.


8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
{
"author": "Erlend Oftedal <[email protected]>",
"name": "retire-scanner",
"version": "1.0.2",
"name": "retire-site-scanner",
"version": "1.0.3",
"license": "Apache-2.0",
"description": "A scanner for checking a web site using retire.js",
"main": "dist/index.js",
"repository": {
"type": "git",
"url": "https://github.com/RetireJS/retire-scanner.git"
},
"bin": {
"retire-scanner": "dist/index.js"
},
Expand Down

0 comments on commit 81fd239

Please sign in to comment.