versionControlDetails object

A versionControlDetails object specifies the information necessary to retrieve from a version control system (VCS) the correct revision of the files that were scanned during the run.

Graph sarif.json Simple API Fluent Builder API

Tip

Generated with following command : php ./resources/serialize.php versionControlDetails docs/assets/sarif 192

docs/assets/sarif/versionControlDetails.json

{
    "$schema": "https://json.schemastore.org/sarif-2.1.0.json",
    "version": "2.1.0",
    "runs": [
        {
            "tool": {
                "driver": {
                    "name": "AndroidStudio",
                    "semanticVersion": "1.0.0-beta.1",
                    "informationUri": "https://android-studion.dev"
                }
            },
            "versionControlProvenance": [
                {
                    "repositoryUri": "https://github.com/example-corp/package",
                    "revisionId": "b87c4e9",
                    "mappedTo": {
                        "uriBaseId": "PACKAGE_ROOT"
                    }
                },
                {
                    "repositoryUri": "https://github.com/example-corp/plugin1",
                    "revisionId": "cafdac7",
                    "mappedTo": {
                        "uri": "plugin1",
                        "uriBaseId": "PACKAGE_ROOT"
                    }
                },
                {
                    "repositoryUri": "https://github.com/example-corp/plugin2",
                    "revisionId": "d0dc2c0",
                    "mappedTo": {
                        "uri": "plugin2",
                        "uriBaseId": "PACKAGE_ROOT"
                    }
                }
            ],
            "results": []
        }
    ]
}

examples/versionControlDetails.php

<?php declare(strict_types=1);
/**
 * This file is part of the Sarif-PHP-SDK package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Laurent Laville
 */

use Bartlett\Sarif\Definition\ArtifactLocation;
use Bartlett\Sarif\Definition\Conversion;
use Bartlett\Sarif\Definition\Invocation;
use Bartlett\Sarif\Definition\Run;
use Bartlett\Sarif\Definition\Tool;
use Bartlett\Sarif\Definition\ToolComponent;
use Bartlett\Sarif\Definition\VersionControlDetails;
use Bartlett\Sarif\SarifLog;

require_once dirname(__DIR__) . '/vendor/autoload.php';

$driver = new ToolComponent();
$driver->setName('AndroidStudio');
$driver->setInformationUri('https://android-studion.dev');
$driver->setSemanticVersion('1.0.0-beta.1');

$tool = new Tool();
$tool->setDriver($driver);

$package = new VersionControlDetails();
$package->setRepositoryUri('https://github.com/example-corp/package');
$package->setRevisionId('b87c4e9');
$packageMappedTo = new ArtifactLocation();
$packageMappedTo->setUriBaseId('PACKAGE_ROOT');
$package->setMappedTo($packageMappedTo);

$plugin1 = new VersionControlDetails();
$plugin1->setRepositoryUri('https://github.com/example-corp/plugin1');
$plugin1->setRevisionId('cafdac7');
$plugin1MappedTo = new ArtifactLocation();
$plugin1MappedTo->setUriBaseId('PACKAGE_ROOT');
$plugin1MappedTo->setUri('plugin1');
$plugin1->setMappedTo($plugin1MappedTo);

$plugin2 = new VersionControlDetails();
$plugin2->setRepositoryUri('https://github.com/example-corp/plugin2');
$plugin2->setRevisionId('d0dc2c0');
$plugin2MappedTo = new ArtifactLocation();
$plugin2MappedTo->setUriBaseId('PACKAGE_ROOT');
$plugin2MappedTo->setUri('plugin2');
$plugin2->setMappedTo($plugin2MappedTo);

$run = new Run();
$run->setTool($tool);
$run->addVersionControlDetails([$package, $plugin1, $plugin2]);

$log = new SarifLog([$run]);

Note

This alternative API is available since release 1.5.0

examples/builder/versionControlDetails.php

<?php declare(strict_types=1);
/**
 * This file is part of the Sarif-PHP-SDK package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Laurent Laville
 */

require_once dirname(__DIR__, 2) . '/vendor/autoload.php';

use Bartlett\Sarif\Factory\BuilderFactory;

$factory = new BuilderFactory();

// @link https://github.com/llaville/sarif-php-sdk/blob/1.1/docs/reference/versionControlDetails.md
$spec = $factory->specification('2.1.0')
    ->addRun(
        $factory->run()
            ->tool(
                $factory->tool()
                    ->driver(
                        $factory->driver()
                            ->name('AndroidStudio')
                            ->semanticVersion('1.0.0-beta.1')
                            ->informationUri('https://android-studion.dev')
                    )
            )
            ->addVersionControlProvenance(
                $factory->versionControlDetails()
                    ->repositoryUri('https://github.com/example-corp/package')
                    ->revisionId('b87c4e9')
                    ->mappedTo(
                        $factory->artifactLocation()
                            ->uriBaseId('PACKAGE_ROOT')
                    )
            )
            ->addVersionControlProvenance(
                $factory->versionControlDetails()
                    ->repositoryUri('https://github.com/example-corp/plugin1')
                    ->revisionId('cafdac7')
                    ->mappedTo(
                        $factory->artifactLocation()
                            ->uri('plugin1')
                            ->uriBaseId('PACKAGE_ROOT')
                    )
            )
            ->addVersionControlProvenance(
                $factory->versionControlDetails()
                    ->repositoryUri('https://github.com/example-corp/plugin2')
                    ->revisionId('d0dc2c0')
                    ->mappedTo(
                        $factory->artifactLocation()
                            ->uri('plugin2')
                            ->uriBaseId('PACKAGE_ROOT')
                    )
            )
    )
;