Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README docs #311

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Improve README docs #311

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 18 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@
Java/Scala library for easily authoring Flyte tasks and workflows.

Current development status:

- MVP features are developed
- Missing user documentation
- Project being tested, and collecting feedback
- No guarantees of API stability

To learn more about Flyte refer to:

- [Flyte homepage](https://flyte.org)
- [Flyte master repository](https://github.com/lyft/flyte)
- [Flyte homepage](https://flyte.org)
- [Flyte master repository](https://github.com/lyft/flyte)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the master repo is now: https://github.com/flyteorg/flyte :)


## Build from source

Expand All @@ -49,7 +50,7 @@ mvn dependency:resolve-plugins

## How to run examples

You can build und run examples yourself.
You can build und run examples yourself.

Create `.env.local` with:

Expand All @@ -62,7 +63,9 @@ FLYTE_STAGING_LOCATION=s3://my-s3-bucket
FLYTE_PLATFORM_INSECURE=True
```

Package and run:
**Note**: If you're registering against [the local Demo Flyte Cluster](https://docs.flyte.org/en/latest/user_guide/environment_setup.html#create-a-local-demo-flyte-cluster), you'll need to adjust the ports to align with it.

Comment on lines +66 to +67
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran into this problem.

Package and register:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not run the workflows, it simply registers them as far as I can tell.


```bash
$ mvn package
Expand All @@ -73,18 +76,17 @@ $ scripts/jflyte register workflows \
-cp=flytekit-examples/target/lib
```

**Note**: `scripts/jflyte` requires `jq` to run, in adition to `docker`
**Note**: `scripts/jflyte` requires `jq` to run, in addition to `docker`

## Usage


### Maven

```
<dependency>
<groupId>org.flyte</groupId>
<artifactId>flytekit-java</artifactId>
<version>0.3.15</version>
<version>0.4.58</version>
</dependency>
```

Expand All @@ -94,20 +96,20 @@ Scala 2.12 and Scala 2.13 are supported.

```scala
libraryDependencies ++= Seq(
"org.flyte" % "flytekit-java" % "0.4.35",
"org.flyte" %% "flytekit-scala" % "0.4.35"
"org.flyte" % "flytekit-java" % "0.4.58",
"org.flyte" %% "flytekit-scala" % "0.4.58"
)
```

## Contributing
## Contributing

Run `mvn spotless:apply` before committing.
Run `mvn spotless:apply` before committing.

Also use `git commit --signoff "Commit message"` to comply with DCO.
Also use `git commit --signoff "Commit message"` to comply with DCO.

## Releasing

* Go to [Actions: Create flytekit-java release](https://github.com/flyteorg/flytekit-java/actions/workflows/release.yaml) and click "Run workflow"
* Wait until the workflow finishes; in the meanwhile prepare a release note
* Making sure the new release is visible in [Maven central](https://repo1.maven.org/maven2/org/flyte/flytekit-java/)
* Publish the release note associating with the latest tag created by the release workflow
- Go to [Actions: Create flytekit-java release](https://github.com/flyteorg/flytekit-java/actions/workflows/release.yaml) and click "Run workflow"
- Wait until the workflow finishes; in the meanwhile prepare a release note
- Making sure the new release is visible in [Maven central](https://repo1.maven.org/maven2/org/flyte/flytekit-java/)
- Publish the release note associating with the latest tag created by the release workflow
Loading