Package io.micronaut.starter.feature.ci.workflows.github

Class GithubCiWorkflowFeature

java.lang.Object

io.micronaut.starter.feature.ci.workflows.CIWorkflowFeature

io.micronaut.starter.feature.ci.workflows.github.GithubCiWorkflowFeature

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature

@Requires(property="micronaut.starter.feature.github.workflow.ci.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class GithubCiWorkflowFeature
extends CIWorkflowFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
GithubCiWorkflowFeature()

Method Summary

Modifier and Type	Method	Description
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
@NonNull String	getDescription()
@NonNull String	getName()	The name of the feature.
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
String	getTitle()
@NonNull String	getWorkflowFileName(GeneratorContext generatorContext)

Methods inherited from class io.micronaut.starter.feature.ci.workflows.CIWorkflowFeature

getCategory, isPreview

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getFrameworkDocumentation, getOrder, isCommunity, isVisible, processSelectedFeatures, supports

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

GithubCiWorkflowFeature

public GithubCiWorkflowFeature()

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Returns:

the name of the feature

getTitle

public String getTitle()

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.

Parameters:

generatorContext - THe generator context

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org

getWorkflowFileName

@NonNull
public @NonNull String getWorkflowFileName(GeneratorContext generatorContext)

Specified by:

getWorkflowFileName in class CIWorkflowFeature