GitlabCoreExtension (ysf-core-plugin 1.0.0 API)

org.ysb33r.ysf.projects.core.extensions.GitlabCoreExtension

@groovy.transform.CompileStatic
class GitlabCoreExtension
extends Object

Gitlab core configuration

Field Summary

Fields
Modifiers	Name	Description
`static String`	`DEFAULT_BRANCH_PROPERTY`
`static String`	`DOCS_DEFAULT_URL`
`static String`	`DOCS_FALLBACK_PROPERTY`
`static String`	`DOCS_PROPERTY`
`static String`	`GITLAB_PAGES`
`static String`	`NAME`
`static String`	`YSF_BASE_URL`

Properties Summary

Properties
Type	Name and description
`Provider<String>`	`docsRootUri`
`Provider<String>`	`gitlabUri`
`Provider<String>`	`projectIdentifier` The numeric identifier of the project.

Constructor Summary

Constructors
Constructor and description
`GitlabCoreExtension (Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Provider<String>`	`getDocsRootUri()` The URL where documentation for this project will be found.
	`Provider<String>`	`getGitlabApiAuthToken()` Obtains the Gitlab API token.
	`Provider<String>`	`getGitlabApiAuthUser()` The user that is interacting with Gitlab.
	`Provider<String>`	`getGitlabBranch()` The Gitlab commit branch.
	`Provider<String>`	`getGitlabDefaultBranch()` The Gitlab default branch.
	`Provider<String>`	`getGitlabUri()` Get the project URI.
	`Provider<String>`	`getIssueUrl()` The URL of the issues page for the project.
	`Provider<Boolean>`	`getPublishAssets()` Whether assets should be published to Gitlab.
	`void`	`setDocsRootUri(Object slug)` Set the documentation uri.
	`void`	`setGitlabUri(Object slug)` Set the project uri.
	`void`	`setPublishAssets(boolean value)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - public static final String DEFAULT_BRANCH_PROPERTY
  - public static final String DOCS_DEFAULT_URL
  - public static final String DOCS_FALLBACK_PROPERTY
  - public static final String DOCS_PROPERTY
  - public static final String GITLAB_PAGES
  - public static final String NAME
  - public static final String YSF_BASE_URL
- Property Detail
  - Provider<String> docsRootUri
  - Provider<String> gitlabUri
  - final Provider<String> projectIdentifier
    
    The numeric identifier of the project.
- Constructor Detail
  - GitlabCoreExtension(Project project)
- Method Detail
  - Provider<String> getDocsRootUri()
    
    The URL where documentation for this project will be found.
    Returns:
    Documentation URI
  - Provider<String> getGitlabApiAuthToken()
    
    Obtains the Gitlab API token.
    Returns:
    Gitlab Token
  - Provider<String> getGitlabApiAuthUser()
    
    The user that is interacting with Gitlab.
    Returns:
    Gitlab user.
  - Provider<String> getGitlabBranch()
    
    The Gitlab commit branch.
    Returns:
    Branch provider
  - Provider<String> getGitlabDefaultBranch()
    
    The Gitlab default branch.
    Returns:
    Branch provider
    Since:
    1.0
  - Provider<String> getGitlabUri()
    
    Get the project URI.
    Returns:
    The full URI
  - Provider<String> getIssueUrl()
    
    The URL of the issues page for the project.
    Returns:
    Issue URL provider.
  - Provider<Boolean> getPublishAssets()
    
    Whether assets should be published to Gitlab.
    Returns:
    true if assets should be published
  - void setDocsRootUri(Object slug)
    
    Set the documentation uri.
    Parameters:
    slug - The project URI.
  - void setGitlabUri(Object slug)
    
    Set the project uri.
    Parameters:
    slug - The project URI.
  - void setPublishAssets(boolean value)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GitlabCoreExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String DEFAULT_BRANCH_PROPERTY

public static final String DOCS_DEFAULT_URL

public static final String DOCS_FALLBACK_PROPERTY

public static final String DOCS_PROPERTY

public static final String GITLAB_PAGES

public static final String NAME

public static final String YSF_BASE_URL

Property Detail

Provider<String> docsRootUri

Provider<String> gitlabUri

final Provider<String> projectIdentifier

Constructor Detail

GitlabCoreExtension(Project project)

Method Detail

Provider<String> getDocsRootUri()

Provider<String> getGitlabApiAuthToken()

Provider<String> getGitlabApiAuthUser()

Provider<String> getGitlabBranch()

Provider<String> getGitlabDefaultBranch()

Provider<String> getGitlabUri()

Provider<String> getIssueUrl()

Provider<Boolean> getPublishAssets()

void setDocsRootUri(Object slug)

void setGitlabUri(Object slug)

void setPublishAssets(boolean value)