Interface GenerateActionsWorkflow

All Superinterfaces:
Comparable<Task>, ExtensionAware, Named, Task
public sealed interface GenerateActionsWorkflow extends Task

This task generates the GitHub Actions workflow file for the project.

If the project is also using the Git Version plugin (currently auto-applied by GradleUtils), it will respect any declared subprojects.

Implementation Note:
See GenerateActionsWorkflowImpl

  • Field Details

    • NAME

      static final String NAME

      The name for this task.

      Each project should only have one of this type of task and it must be named this.

      See Also:

  • Method Details

    • getOutputFile

      @OutputFile RegularFileProperty getOutputFile()
      The output file for this task.

      Default: rootProject/.github/workflows/publish_name.yaml

      Returns:
      The property for the output file

    • getProjectName

      @Input Property<String> getProjectName()

      The project name to use in the workflow file.

      Default: Project.getName()

      Returns:
      The property for the project name

    • getBranch

      @Optional @Input Property<String> getBranch()

      The branch name to use in the workflow file.

      Default: Automatically detected by Git Version, otherwise master

      Returns:
      The property for the branch name
      Implementation Note:
      See GenerateActionsWorkflowImpl.DEFAULT_BRANCH

    • getLocalPath

      @Optional @Input Property<String> getLocalPath()
      The local path from the root project to the current project to use in the workflow file. This local path is not used to invoke Gradle but rather for Git Version.
      Returns:
      The property for the local path

    • getPaths

      @Optional @Input ListProperty<String> getPaths()
      The paths to pass into the workflow file. Prepend a path with ! to ignore it instead of include it. The Git Version plugin will automatically add declared subproject paths to exclude.
      Returns:
      The property for the paths

    • getGradleJavaVersion

      @Input Property<Integer> getGradleJavaVersion()

      The Java version to invoke Gradle with.

      Default: The project's toolchain version, or 17 if it is lower than that.

      Returns:
      The property for the Gradle Java version
      Implementation Note:
      See GenerateActionsWorkflowImpl.DEFAULT_GRADLE_JAVA

    • getSharedActionsBranch

      @Input Property<String> getSharedActionsBranch()

      The Shared Actions branch to use with this workflow.

      Default: v0

      Returns:
      The property for the Shared Actions branch
      Implementation Note:
      See GenerateActionsWorkflowImpl.DEFAULT_SHARED_ACTIONS_BRANCH