IJ is a build tool using Docker containers.
A build is defined by a sequence of tasks which perform some unit of work (e.g. building a binary, running integration tests, pushing artifacts to a remote server), usually within a docker container. This ensures that the development host stays clean, and that the exact build dependencies are available within the container (no more development tool version hell). The build process is defined by assembling a sequence of tasks into a plan. A build is simply the invocation of one or more plans. A project's config file declares tasks and plans which builds the project.
Simply run go install github.com/efritz/ij.
There are currently four IJ subcommands (run, login, logout, and rotate-logs) each discussed below. The following command line flags are applicable for all IJ commands.
| Name | Short Flag | Description |
|---|---|---|
| config | f | The path to the config file. If not supplied, ij.yaml and ij.yml are attempted in the current directory. |
| env | e | Set an environment variable. Use -e VAR=VAL to set an explicit value for the variable VAR. Use -e VAR to use the host value of $VAR. |
| env-file | The path to an environment file. | |
| no-color | Disable colorized output. | |
| verbose | v | Show debug-level output. |
This command can be invoked as ij [run]? (plan-name)*. The run keyword is assumed if not supplied. This command runs a series of plans or metaplans defined in the config file. If no plan-names are supplied, the plan named default is invoked.
| Name | Short Flag | Description |
|---|---|---|
| cpu-shares | c | The proc limit for run task containers. |
| force-sequential | Disable running tasks in parallel. | |
| healthcheck-interval | How frequently to check the health of service containers. | |
| keep-workspace | k | Do not prune the scratch directory (useful for debugging failed plans). |
| login | Login to registries before invoking plans and logout from registries after (useful for builds that push image artifacts). | |
| memory | m | The memory limit for run task containers. |
| ssh-identity | An additional SSH key fingerprint required to be present in the host's SSH agent. | |
| timeout | The maximum time a build plan can run in total. |
This command can be invoked as ij login. Login to all registries defined in the config file.
This command can be invoked as ij logout. Logout from all registries defined in the config file.
This command can be invoked as ij rotate-logs. Remove all but the most recent run from the .ij directory in the current project.
Copyright (c) 2018 Eric Fritz
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.