1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.cli.cisupport;
20
21 import org.apache.maven.api.annotations.Nonnull;
22
23 /**
24 * CI support: this class contains gathered information and more from CI that Maven process runs on.
25 *
26 * @since 4.0.0
27 */
28 public interface CIInfo {
29 /**
30 * Short distinct name of CI system: "GH", "Jenkins", etc.
31 */
32 @Nonnull
33 String name();
34
35 /**
36 * May return a message that will be logged by Maven explaining why it was detected (and possibly more).
37 */
38 @Nonnull
39 default String message() {
40 return "";
41 }
42
43 /**
44 * Some CI systems may allow running jobs in "debug" (or some equivalent) mode.
45 */
46 default boolean isVerbose() {
47 return false;
48 }
49 }