Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(readme): drop HTML-tags to fix rendering #3032

Merged
merged 3 commits into from
Jun 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The Application Autoscaler provides the capability to adjust the computation res
through

* dynamic scaling based on application performance metrics
* dynamic scaling based on custom metrics
* scheduled scaling based on time

## Local Development
Expand All @@ -17,23 +18,23 @@ through

### Make Targets

| Category | Description | Target |
|-------------------|----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| mock | generate mocks | `make generate-fakes` |
| unit-tests | run against PostgreSQL | `make test` |
| unit-tests | run against specific PostgreSQL version | <pre><code>make clean #Only if you're changing versions to refresh the running docker image<br/>make test POSTGRES_TAG=x.y</code></pre> |
| unit-tests | run against MySQL | `make test db_type=mysql` |
| unit-tests | run against specific MySQL version | <pre><code>make clean #Only if you're changing versions to refresh the running docker image<br/>make test db_type=mysql MYSQL_TAG=x.y</code></pre> |
| integration-tests | run against PostgreSQL | `make integration` |
| integration-tests | run against specific PostgreSQL version | <pre><code>make clean #Only if you're changing versions to refresh the running docker image<br/>make integration POSTGRES_TAG=x.y</code></pre> |
| integration-tests | run against MySQL | `make integration db_type=mysql` |
| integration-tests | run against specific MySQL version | <pre><code>make clean #Only if you're changing versions to refresh the running docker image<br/>make integration db_type=mysql MYSQL_TAG=x.y</code></pre> |
| acceptance-tests | run acceptance-tests, see [AutoScaler UAT guide](src/acceptance/README.md) for details | `make acceptance-tests` |
| lint | check code style | `make lint` |
| lint | check code style and apply auto-fixes | `OPTS=--fix RUBOCOP_OPTS=-A make lint` |
| build | compile project | `make build` |
| deploy | deploy Application Autoscaler and register the service broker in CF | `make deploy-autoscaler` |
| cleanup | remove build artifacts | `make clean` |
| Target | Description |
|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| `make generate-fakes` | generate mocks |
| `make test` | run unit-tests against PostgreSQL |
| `make clean && make test POSTGRES_TAG=x.y` | run unit-tests against specific PostgreSQL version |
| `make test db_type=mysql` | run unit-tests against MySQL |
| `make clean && make test db_type=mysql MYSQL_TAG=x.y` | run unit-tests against specific MySQL version |
| `make integration` | run integration-tests against PostgreSQL |
| `make clean && make integration POSTGRES_TAG=x.y` | run integration-tests against specific PostgreSQL version |
| `make integration db_type=mysql` | run integration-tests against MySQL |
| `make clean && make integration db_type=mysql MYSQL_TAG=x.y` | run integration-tests against specific MySQL version |
| `make acceptance-tests` | run acceptance-tests, see [AutoScaler UAT guide](src/acceptance/README.md) for details |
| `make lint` | check code style |
| `OPTS=--fix RUBOCOP_OPTS=-A make lint` | check code style and apply auto-fixes |
| `make build` | compile project |
| `make deploy-autoscaler` | deploy Application Autoscaler and register the service broker in CF |
| `make clean` | remove build artifacts |

## Use Application Autoscaler Service

Expand Down
Loading