order

README

Order

✔ A modern approach to running your tasks

⚠ Please be warned that the project is early in its development, which means the API and code base are generally unstable for the short term.

Introduction

Order is a versatile task runner / build system created to assist with the project development and maintance processes.

It's main goal is to give to the developer:

• script definition file with clear and intuitive structure
• task-based subcommands
  • [not yet implemented] with support for user-defined flagset
• [not yet implemented] task inheritance which provides:
  • centralization of common task code (multirepo project support)
  • ability to divide tasks into file-based, aliased namespaces
  • support for parent task checksum validation
  • optional separation between definition and implementation
  • compilation of whole inheritance tree to single file

See ROADMAP for more details on feature development progress.

Installation

Latest version from Source

go get -u github.com/DamianSkrzypczak/order

Usage

Usage: order [options...] <order-name>

Options:
      --debug         debug mode
  -l, --list          list orders
      --no-color      do not color the output
      --no-command    hide currently executed command
      --no-level      hide logging level
  -p, --path string   path to orderfile (default "./Orderfile.yml")
      --version       print version of order (and if loaded, Orderfile.yml)

Documentation

See damianskrzypczak.github.io/order for the documentation.

Contribution & Code of conduct

See CONTRIBUTING.md and our CODE_OF_CONDUCT for more details on contribution process.

Conventions

This project utilizes:

• Semantic Versioning for versioning
• Conventional Commits for commit messages
• Keep a changelog for CHANGELOG
• Contributor Covenant for code of conduct

Credit & License

Order is licensed under the terms of the MIT license. You can find the complete text in LICENSE.

Please refer to the Git commit log for a complete list of contributors.

Documentation

Overview

Package main serves as command line entry point for order application, it is also responsible for

• handling errors on highest level and returning error codes
• logging setup
• metadata definition (version, etc.)