OmniFlow

OmniFlow

Explore the documentation »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Uses
2. Getting Started
   • Prerequisites
   • Installation
3. Documentation
4. Setup
   • Environment variables
5. Usage
   • Running
   • CLI
   • Make a Release
6. How it works
7. Build
8. Contributing
9. License
10. Authors

About The Project

Omniflow is a tool to create updater files, for EnVRonment

(back to top)

Uses

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

You will need to install some tools to run the project.

• You will need infisical-cli and an account on https://infisical.envronment.com, to fetch environment variables.
• You will also need Docker and docker-compose to run the database and the cache.
• You will need to install Git to clone the project.
• You will need to install Intellij Idea to edit the project.
• You will need to install Java v21 to run the project.

Installation

Clone the project and install the dependencies.

Clone & install

git clone [email protected]:StreetLess/OmniFlow.git
cd OmniFlow
./gradlew build --refresh-dependencies

(back to top)

Documentation

No documentation available yet.

Setup

Environment variables

You will need to login to https://infisical.envronment.com and fetch the environment variables.

infisical login
# Choose self-hosted, type the url of the server

To fetch the environment variables, run the following command:

# --env is optional, by default it will fetch the dev environment. If you are on main or release/* branch it will fetch production environment.
infisical export --env dev > .env

# If you want more information about the environment variables run the following command to generate the example file
infisical secrets generate-example-env > .env.sample

Usage

Running

You can run the project with the following command:

# You'll need to pass the cli arguments in --args=""
./gradlew run --args=""

CLI

A CLI is available to run some commands. You will need to configure the .env. You can run it with the following command:

usage: [-h] [-d DIRECTORY] -v VERSION --editor [--new] [--clear] [--release]

required arguments:
  -v VERSION,             The version to push
  --version VERSION

  --editor, --simulator   The project type


optional arguments:
  -h, --help              show this help message and exit

  -d DIRECTORY,           The directory to push
  --directory DIRECTORY

  --new, --temporary      The mode to use

  --clear, -c             Clear directory version before uploading

  --release, --debug      The build type

Make a Release

To make a release from scratch, you need to make a temporary version, and then a release

# Push the content of /path/to/directory to the temporary bucket, for "editor" project type, with version 1.0.0, as a release type
java -jar OmniFlow.jar --editor --temporary --version 1.0.0 --directory /path/to/directory --release
# Make the release from the temporary bucket to the release bucket
java -jar OmniFlow.jar --editor --version 1.0.0 --new --release

(back to top)

How it works

When you run the jar, you specify:

• --editor or --simulator to specify the project type (mandatory)
• --version to specify the version (mandatory)
• --directory to specify the directory to push (only when --new is not specified)
• --new to specify that you want to create a new version (optional), you need to make a temporary version before
• --clear to specify that you want to clear the directory version before uploading (optional) (only when --new is not specified)
• --release or --debug to specify the build type (optional) (default: --release)

(back to top)

Build

If you need to build the project:

./gradlew shadowJar
ls -L /build/libs

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Read the contributing guide to learn how to contribute to the project.

(back to top)

License

Distributed under the License. See LICENSE for more information.

(back to top)

Authors

Alwyn974