-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: deprecate sonarqube-actions (#2497)
* chore: deprecate sonarqube-actions Signed-off-by: Kashish Mittal <kmittal@redhat.com> * regen yarn.lock Signed-off-by: Kashish Mittal <kmittal@redhat.com> --------- Signed-off-by: Kashish Mittal <kmittal@redhat.com>
- Loading branch information
Showing
21 changed files
with
2 additions
and
1,272 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,3 @@ | ||
# SonarQube actions for Backstage | ||
# Deprecated | ||
|
||
This module provides [Backstage](https://backstage.io/) template [actions](https://backstage.io/docs/features/software-templates/builtin-actions) for [SonarQube](https://docs.sonarqube.org/latest/). | ||
|
||
The following actions are currently supported in this module: | ||
|
||
- Create a SonarQube [project](https://docs.sonarqube.org/latest/user-guide/project-page/) | ||
|
||
## Prerequisites | ||
|
||
- A [Backstage](https://backstage.io/docs/getting-started/) project | ||
- A [SonarQube](https://docs.sonarqube.org/latest/) instance | ||
|
||
## Installation | ||
|
||
Run the following command to install the action package in your Backstage project: | ||
|
||
```console | ||
yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-sonarqube | ||
``` | ||
|
||
### Installing the action on the new backend | ||
|
||
Add the following to your `packages/backend/src/index.ts` file: | ||
|
||
```ts title="packages/backend/src/index.ts" | ||
const backend = createBackend(); | ||
|
||
// Add the following line | ||
backend.add(import('@janus-idp/backstage-scaffolder-backend-module-sonarqube')); | ||
|
||
backend.start(); | ||
``` | ||
|
||
## Configuration | ||
|
||
Add the SonarQube actions to your templates, see the [examples](./examples/templates) directory of this repository for complete usage examples | ||
|
||
```yaml | ||
action: sonarqube:create-project | ||
id: 'create-sonar-project' | ||
name: 'Create SonarQube Project' | ||
input: | ||
baseUrl: 'https://sonarqube.com' | ||
token: '4518a13e-093f-4b66-afac-46a1aece3149' | ||
name: 'My SonarQube Project' | ||
key: 'my-sonarqube-project' | ||
branch: 'main' | ||
visibility: 'public' | ||
``` | ||
## Usage | ||
### Action: sonarqube:create-project | ||
#### Input | ||
| Parameter Name | Type | Required | Description | Example | | ||
| -------------- | :----: | :------: | ------------------------------------------------------------------------------------------------------------------------ | ----------------------- | | ||
| baseUrl | string | Yes | SonarQube Instance base URL | <http://sonar.acme.org> | | ||
| name | string | Yes | Name of the project to be created in SonarQube | My Project | | ||
| key | string | Yes | Key of the project to be created in SonarQube | my-project | | ||
| branch | string | No | Key of the main branch of the project. If not provided, the default main branch key will be used. | main | | ||
| visibility | string | No | Whether the created project should be visible to everyone, or only specific user/groups. | private or public | | ||
| token | string | No | SonarQube authentication [token](https://docs.sonarqube.org/latest/user-guide/user-account/generating-and-using-tokens/) | | | ||
| username | string | No | SonarQube username | | | ||
| password | string | No | SonarQube password | | | ||
> **Warning** | ||
> | ||
> Either the `token` or `username` and `password` input combination are required. | ||
> If the three of them are provided, the `token` will take precedence | ||
|
||
#### Output | ||
|
||
| Name | Type | Description | | ||
| ---------- | :----: | -------------------------------------------- | | ||
| projectUrl | string | SonarQube project URL created by this action | | ||
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-scaffolder-backend-module-sonarqube` instead. |
This file was deleted.
Oops, something went wrong.
82 changes: 0 additions & 82 deletions
82
plugins/sonarqube-actions/examples/templates/01-sonar-template.yaml
This file was deleted.
Oops, something went wrong.
89 changes: 0 additions & 89 deletions
89
plugins/sonarqube-actions/examples/templates/02-sonar-template.yaml
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.