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

@Singleton
public class GithubCiWorkflowFeature
extends CIWorkflowFeature

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
GithubCiWorkflowFeature()

Method Summary

Modifier and Type	Method and 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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
java.lang.String	getDescription()
java.lang.String	getName() The name of the feature.
java.lang.String	getThirdPartyDocumentation()
java.lang.String	getTitle()
java.lang.String	getWorkflowFileName(GeneratorContext generatorContext)

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

getCategory, isPreview, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.starter.feature.Feature

getMicronautDocumentation, getOrder, isCommunity, isVisible, processSelectedFeatures

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

getDescription

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

GithubCiWorkflowFeature

public GithubCiWorkflowFeature()

Method Detail

getName

@NonNull
public java.lang.String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Returns:

the name of the feature

getTitle

public java.lang.String getTitle()

Returns:

The title of the feature

getDescription

@NonNull
public java.lang.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(ApplicationType, 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. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Parameters:

generatorContext - THe generator context

getThirdPartyDocumentation

public java.lang.String getThirdPartyDocumentation()

Returns:

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

getWorkflowFileName

@NonNull
public java.lang.String getWorkflowFileName(GeneratorContext generatorContext)

Specified by:

getWorkflowFileName in class CIWorkflowFeature