[FEATURE] Register new repository in `SonarCloud` via API

[guibranco]

Description

We need to implement functionality to register a new repository with SonarCloud using the SonarCloud API. This will enable code quality and security analysis for the repository and integrate it into our SonarCloud dashboard.

Tech Notes

• SonarCloud API Documentation:
  • For details on how to interact with the SonarCloud API and perform repository registration, refer to the SonarCloud Web API Documentation.

Steps to Implement

1. Obtain API Credentials:

   • Ensure you have the necessary API credentials for SonarCloud, including an API token.

2. Register Repository:

   • Create a script or tool to interact with the SonarCloud API and register the repository. This typically involves making authenticated HTTP requests to the SonarCloud API endpoint for repository registration.

3. Verify Registration:

   • Confirm that the repository has been successfully registered with SonarCloud. Check that the repository appears in the SonarCloud dashboard and that code quality metrics are available.

Example

Here is a conceptual PHP example (adjust according to actual API documentation):

use GuiBranco\Pancake\Request;

class SonarCloudRegistrar
{
    private $sonarToken;
    private $sonarApiUrl = 'https://sonarcloud.io/api';

    public function __construct($sonarToken)
    {
        $this->sonarToken = $sonarToken;
    }

    public function registerRepository($projectKey)
    {
        $request = new Request();
        $response = $request->post("{$this->sonarApiUrl}/projects/create", [
            'headers' => [
                'Authorization' => "Basic " . base64_encode("{$this->sonarToken}:"),
                'Accept'        => 'application/json',
            ],
            'json' => [
                'projectKey' => $projectKey,
                'name'       => 'New Project Name', // Adjust as needed
            ],
        ]);

        if ($response->getStatusCode() == 200) {
            return $response->getBody();
        }

        throw new Exception('Failed to register repository with SonarCloud.');
    }
}

// Usage example
$registrar = new SonarCloudRegistrar('your-sonarcloud-token');
$registrar->registerRepository('your-project-key');

Expected Outcome

• The new repository is successfully registered with SonarCloud via the API.
• The repository appears in the SonarCloud dashboard, and code quality metrics are available.

[gitauto-ai[bot]]

▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 10% Writing a pull request body...