Package com.coravy.hudson.plugins.github

Class GithubProjectProperty

java.lang.Object
hudson.model.JobProperty<Job<?,?>>
com.coravy.hudson.plugins.github.GithubProjectProperty
All Implemented Interfaces:
ExtensionPoint, Describable<JobProperty<?>>, ReconfigurableDescribable<JobProperty<?>>, BuildStep
public final class GithubProjectProperty extends JobProperty<Job<?,?>>
Stores the github related project properties.

- URL to the GitHub project - Build status context name

Author:
Stefan Saasen

  • Constructor Details

    • GithubProjectProperty

      @DataBoundConstructor public GithubProjectProperty(String projectUrlStr)

  • Method Details

    • getProjectUrlStr

      public String getProjectUrlStr()
      Same as getProjectUrl(), but with a property name and type which match those used in the GithubProjectProperty(java.lang.String) constructor. Should have been called getProjectUrl and that method called something else (such as getNormalizedProjectUrl), but that cannot be done compatibly now.

    • getProjectUrl

      public GithubUrl getProjectUrl()
      Returns:
      the projectUrl

    • getDisplayName

      @CheckForNull public String getDisplayName()
      Since:
      1.14.1
      See Also:
      • displayName

    • setDisplayName

      @DataBoundSetter public void setDisplayName(String displayName)
      Since:
      1.14.1

    • displayNameFor

      public static String displayNameFor(@NonNull Job<?,?> job)
      Extracts value of display name from given job, or just returns full name if field or prop is not defined
      Parameters:
      job - project which wants to get current context name to use in GH status API
      Returns:
      display name or full job name if field is not defined
      Since:
      1.14.1