Import, Extend, Ship

Examples for:

Gradle + Kotlin Maven + Java

This tutorial completes the Typeflows Cycle by showing you how to import published packages, extend them with your own requirements, and ship the final configuration. You’ll import and use published Typeflows packages and include other standard files we defined in the last tutorial.

Prerequisites

Completion of the Package and Publish tutorial
Access to the published package from the previous tutorial

Step 1: Setup Build System

First, configure your build system with Typeflows and add the published package as a dependency:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

plugins {
	kotlin("jvm")
	id("io.typeflows") version "1.0.0"
}

repositories {
	mavenCentral()
	maven("https://maven.pkg.github.com/example/typeflows-standards")
}

dependencies {
	implementation("io.typeflows:typeflows-github:1.0.0")
	implementation("com.example:typeflows-standards:1.0.0")
}

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.example</groupId>
	<artifactId>typeflows-import-example</artifactId>
	<version>1.0.0</version>
	
	<properties>
		<maven.compiler.source>21</maven.compiler.source>
		<maven.compiler.target>21</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<repositories>
		<repository>
			<id>central</id>
			<url>https://repo1.maven.org/maven2</url>
		</repository>
		<repository>
			<id>github</id>
			<url>https://maven.pkg.github.com/example/typeflows-standards</url>
		</repository>
	</repositories>

	<dependencies>
		<dependency>
			<groupId>io.typeflows</groupId>
			<artifactId>typeflows-github</artifactId>
			<version>1.0.0</version>
		</dependency>
		
		<dependency>
			<groupId>com.example</groupId>
			<artifactId>typeflows-standards</artifactId>
			<version>1.0.0</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>io.typeflows</groupId>
				<artifactId>typeflows-maven-plugin</artifactId>
				<version>1.0.0</version>
			</plugin>
		</plugins>
	</build>
</project>

Step 2: Create Complete Repository Configuration

Let’s create a complete repository configuration that demonstrates both importing published components and extending them with composition. This will include multiple scheduled greeting workflows and the StandardRepoFiles resource files (containing the LICENSE):

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

class Typeflows : Builder<TypeflowsFSEntry> {
	override fun build() = TypeflowsGitHubRepo {
		dotGithub = DotGitHub {

			workflows += ScheduledGreeting("morning", Cron.of("0 9 * * *"), "Good morning!")
			workflows += ScheduledGreeting("weekend", Cron.of("0 10 * * 5"), "Happy weekend!")
		}

		files += StandardRepoFiles()
	}
}

public class Typeflows implements Builder<TypeflowsRepo> {

	@Override
	public TypeflowsRepo build() {
		return TypeflowsGitHubRepo.create(repo -> {
			repo.dotGithub = DotGitHub.create(dotGithub -> {
				dotGithub.workflows.add(
					List.of(
					    new ScheduledGreeting("good-morning", Cron.of("0 9 * * *"), "Good morning!"),
					    new ScheduledGreeting("good-evening", Cron.of("0 10 * * *"), "Good evening!"),
					    new ScheduledGreeting("happy-weekend", Cron.of("0 10 * * 5"), "Happy weekend!")
					)
				);
			});
			repo.files.add(new StandardRepoFiles());
		});
	}
}

Step 3: Export and Verify

Run the export process to generate all your configured files:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

./gradlew typeflowsExport

cd typeflows && mvn typeflows:export

Check the generated files to see the results of your composition:

Better Experience in Landscape Mode

The code examples look much better when viewed horizontally. Please rotate your device for the best experience!

Or view on a larger screen to see the code!

on:
  schedule:
	- cron: '0 9 * * *'

jobs:
  greeting:
	runs-on: ubuntu-latest
	steps:
	  - name: Send greeting message
		run: |
		  echo "Good morning!"

on:
  schedule:
	- cron: '0 10 * * 5'

jobs:
  greeting:
	runs-on: ubuntu-latest
	steps:
	  - name: Send greeting message
		run: |
		  echo "Happy weekend!"

MIT License

Copyright (c) 2024 Example Corp

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Conclusion

You’ve now completed the full Typeflows Cycle, demonstrating how to import published packages, extend them with your own requirements, and export the final configuration. Your repository now has imported multiple scheduled workflows and other files, all managed through type-safe configuration.