README
¶
cirocket
Rocket powered task runner to assist delivering ci build missions
Status
This project is in its early alpha MVP stage. It may be subject to change or redesign, but the hope is not to break any existing scripts using the tool.
Documentation is limited. Current sources include this README and the sample config file generated by cirocket init
If you find and problem or want to contribute please see the contribution section below.
Installation
To install either clone the repository or use the go tool chain to install.
git clone https://github.com/nehemming/cirocket.git
cd cirocket
go install
or
go install github.com/nehemming/cirocket@latest
Basic usage
cirocket is a simple task runner application that uses a configuration file to specify the tasks.
To create a sample config file, along with some basic documentation run:
cirocket init
This will create a .cirocket.yml file in the current working directory.
Here is example sample
Once edited the file can be run using
cirocket launch
Different mission files can be specified by adding to either command the --config <filename> flag.
Contributing
We would welcome contributions to this project. Please read our CONTRIBUTION file for further details on how you can participate or report any issues.
License
This software is licensed under the Apache License.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
cmd
Package cmd provides the command line interface to cirocket.
|
Package cmd provides the command line interface to cirocket. |
|
pkg
|
|
|
buildinfo
Package buildinfo stores information about an applications current build
|
Package buildinfo stores information about an applications current build |
|
cliparse
Package cliparser converts a command line string into CommandLine program and args struct
|
Package cliparser converts a command line string into CommandLine program and args struct |
|
loggee
Package loggee is logging wrapper interface that allows share packages to call logging services without the calling application being tide to a specific implementation.
|
Package loggee is logging wrapper interface that allows share packages to call logging services without the calling application being tide to a specific implementation. |
|
loggee/stdlog
Package stdlog implements a loggee wrapper around the standard log package
|
Package stdlog implements a loggee wrapper around the standard log package |