AntoraGitlabTagManipulator (ysf-core-plugin 0.2.4 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.ysb33r.ysf.projects.core.internal.gitlab.AntoraGitlabTagManipulator

@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
class AntoraGitlabTagManipulator
extends Object

Utility to work with Antora Gitlab tags.

Properties Summary

Properties
Type	Name and description
`GitlabProjectClient`	`client`
`boolean`	`stackTraceWithDeleteFailure`

Constructor Summary

Constructors
Constructor and description
`AntoraGitlabTagManipulator (GitlabProjectClient client, boolean stackTraceWithDeleteFailure)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`createTag(String tag, String ref)` Creates a tag in Gitlab.
	`void`	`deleteTagIfExists(String tagToDelete)`
	`java.util.Map<String, CharSequence>`	`standardHeaders(String gitlabToken)`
	`String`	`tagsHostPath(String projectId)` Gitlab path to tags API.

Inherited Methods Summary

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

- Property Detail
  - final GitlabProjectClient client
  - final boolean stackTraceWithDeleteFailure
- Constructor Detail
  - AntoraGitlabTagManipulator(GitlabProjectClient client, boolean stackTraceWithDeleteFailure)
- Method Detail
  - void createTag(String tag, String ref)
    
    Creates a tag in Gitlab.
    Parameters:
    tag - The tag that needs to be created
    ref - The Gitlab reference on which to tag.
  - void deleteTagIfExists(String tagToDelete)
  - java.util.Map<String, CharSequence> standardHeaders(String gitlabToken)
  - String tagsHostPath(String projectId)
    
    Gitlab path to tags API.
    Parameters:
    projectId - Gitlab numerical project identifier.
    Returns:
    API path.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation