1build is an automation tool that arms you with the convenience to configure project-local command line aliases – and then
run the commands quickly and easily. It is particularly helpful when you deal with multiple projects and switch between
them all the time. It is often the fact that different projects use different build tools and have different environment
requirements – and then switching from one project to another is becoming increasingly cumbersome. That is where 1build comes
into play.
With 1build you can create simple and easily memorable command aliases for commonly used project commands such as build,
test, run or anything else. These aliases will have a project-local scope which means that they will be accessible only
within the project directory. This way you can unify all your projects to build with the same simple command disregarding
of what build tool they use. It will remove the hassle of remembering all those commands improving the mental focus for
the things that actually matter.
Install
- Download and unzip latest release for your OS.
- Move the
1build
executable to your $PATH
.
Usage
Configuration
Running 1build for the above sample project:
Set new or update existing configuration
Remove/Unset existing configuration
- Unset command configuration for
lint
1build unset lint
Using before
and after
commands
Consider that your project requires some environment variables to set before running any
commands and you want to clean up those after running commands. It is a headache to always
remember to set those environment variables. What you want is to set env variables automatically
when you run the command in the project and remove those when the command is complete.
Another example – a project requires Docker
to be up
and running or you need to clean up the database after running a test harness.
This is where before
& after
commands are useful. These commands are both optional –
you can use one of them, both or neither.
Examples:
-
Setting env variables and cleaning those up
project: Sample JVM Project Name
before: export VARNAME="my value"
after: unset VARNAME
commands:
- build: npm run build
-
Ensure that Docker
is up and running
project: Containerized Project
before: ./docker_run.sh
commands:
- build: npm run build
-
Clean up database after some commands
project: Containerized Project
after: ./clean_database.sh
commands:
- build: npm run build
See 1build --help
for command usages.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use Semantic Versioning for all our releases. For the versions available, see the tags on this repository.
Changelog
All notable changes to this project in each release will be documented in CHANGELOG.md.
The format is based on Keep a Changelog.
License
This project is licensed under the MIT License - see the LICENSE file for details
Authors
See also the list of contributors who participated in this project.