org.sonar.scanner.ci.CiConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation
Show all versions of sonar-scanner-engine Show documentation
Open source platform for continuous inspection of code quality
/*
* SonarQube
* Copyright (C) 2009-2023 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.scanner.ci;
import java.util.Optional;
/**
* Configuration provided by CI environments like TravisCI or Jenkins.
*
* @see CiVendor
*/
public interface CiConfiguration {
/**
* Name of the CI environment
*/
String getCiName();
/**
* The revision that triggered the analysis. It should
* be the revision as seen by end-user, but not the necessarily
* the effective revision of the clone on disk (merge commit with
* base branch for instance).
*/
Optional getScmRevision();
/**
* The information about DevOpsPlatform that was detected.
*/
Optional getDevOpsPlatformInfo();
}