Skip to content

Commit

Permalink
🐛 Fixed spelling (konveyor#66)
Browse files Browse the repository at this point in the history
Analyzer-lsp is spelled with a `z` not an `s`, so I figured it would be
best to keep the spelling consistent across the project.
  • Loading branch information
JonahSussman authored Dec 11, 2023
1 parent 673b1e1 commit b9eb18a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# tackle2-addon-analyzer

[![Analyser Addon Repository on Quay](https://quay.io/repository/konveyor/tackle2-addon-analyzer/status "Analyser Addon Repository on Quay")](https://quay.io/repository/konveyor/tackle2-addon-analyzer) [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/konveyor/tackle2-addon-analyzer/pulls) [![Test Analyser Addon](https://github.com/konveyor/tackle2-addon-analyzer/actions/workflows/test-analyzer.yml/badge.svg?branch=main)](https://github.com/konveyor/tackle2-addon-analyzer/actions/workflows/test-analyzer.yml)
[![Analyzer Addon Repository on Quay](https://quay.io/repository/konveyor/tackle2-addon-analyzer/status "Analyzer Addon Repository on Quay")](https://quay.io/repository/konveyor/tackle2-addon-analyzer) [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/konveyor/tackle2-addon-analyzer/pulls) [![Test Analyzer Addon](https://github.com/konveyor/tackle2-addon-analyzer/actions/workflows/test-analyzer.yml/badge.svg?branch=main)](https://github.com/konveyor/tackle2-addon-analyzer/actions/workflows/test-analyzer.yml)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.jparrowsec.cn%2Fkonveyor%2Ftackle2-addon-analyzer.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.jparrowsec.cn%2Fkonveyor%2Ftackle2-addon-analyzer?ref=badge_shield)

Tackle (2nd generation) addon for Analyser.
Tackle (2nd generation) addon for Analyzer.


Task data.
Expand Down
8 changes: 4 additions & 4 deletions doc/hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ The above JSON creates a Source Analysis task for Application 1 that uses both a

* `name`: A name for the task
* `addon`: The name of the addon to run. This must match the name of the analysis addon CR. In this case it should be `windup`.
* `application`: This is an object with an `id` key where the value is the ID of the Application to analyse.
* `application`: This is an object with an `id` key where the value is the ID of the Application to analyze.
* `state`: This must be set to `Created` or `Ready` when creating the Task. The task will start as soon as possible if this is set to `Ready`. If the task is created with the state set to `Created`, a follow up `PUT` to `/tasks/:id/` will be necessary to change the state to `Ready` to start the task. Once the task is started, the Hub will automatically update the state to `Running`, `Succeeded` or `Failed` as appropriate.
* `data`: A structure containing parameters for the analysis.
- `output`: The path in the application bucket where the analysis report should be generated. This should be `/windup/report` to be consistent with analysis run from the UI. This directory is cleared when starting a new analysis.
- `mode`:
- `binary`: Boolean. If true this is a binary analysis, else a source analysis.
- `artifact`: Path in the application bucket to a previously uploaded binary artifact to analyse instead of the one specified on the Application object. Binary analysis only.
- `withDeps`: Boolean. Analyse dependencies. Source analysis only.
- `artifact`: Path in the application bucket to a previously uploaded binary artifact to analyze instead of the one specified on the Application object. Binary analysis only.
- `withDeps`: Boolean. analyze dependencies. Source analysis only.
- `diva`: Boolean. Enables transaction analysis
- `csv`: Boolean. Generate the report data in CSV format, in addition to HTML.
- `rules`:
Expand All @@ -87,7 +87,7 @@ The above JSON creates a Source Analysis task for Application 1 that uses both a
- `packages`:
- `excluded`: List of packages to exclude
- `included`: List of packages to include. If this is empty, every package in the application is scanned.
- `withKnown` - Boolean. Analyse known libraries embedded in your application. By default only application code is analysed.
- `withKnown` - Boolean. Analyze known libraries embedded in your application. By default only application code is analyzed.
- `sources`: List of source technologies to migrate from. In conjunction with the targets this helps to determine what rulesets are used. The list of builtin sources can be found in the UI.
- `targets`: List of target technologies to migrate to. In conjunction with the sources this helps to determine what rulesets are used. The list of builtin targets can be found in the UI.

Expand Down

0 comments on commit b9eb18a

Please sign in to comment.