Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/travis-ci/travis-build
.travis.yml => build.sh converter
https://github.com/travis-ci/travis-build
ruby travis-ci
Last synced: 4 days ago
JSON representation
.travis.yml => build.sh converter
- Host: GitHub
- URL: https://github.com/travis-ci/travis-build
- Owner: travis-ci
- License: mit
- Created: 2011-10-03T21:46:00.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T11:34:58.000Z (7 months ago)
- Last Synced: 2024-05-22T12:19:21.966Z (7 months ago)
- Topics: ruby, travis-ci
- Language: Ruby
- Homepage:
- Size: 8.03 MB
- Stars: 655
- Watchers: 47
- Forks: 436
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Travis Build [](https://travis-ci.com/travis-ci/travis-build)
Travis Build exposes an API that [Travis
Workers](https://github.com/travis-ci/worker) and [Job
Board](https://github.com/travis-ci/job-board) use to generate a bash script
which is then copied to the job execution environment and executed, with the
resulting output streamed back to Travis.
This code base has gone through several iterations of development, and was
originally extracted from [the legacy Travis
Worker](https://github.com/travis-ci/travis-worker), before taking its current
form.
## Running test suites
Run
``` bash
bundle exec rake spec
```
## Use as addon for Travis CLI
You can set travis-build up as a plugin for the [command line
client](https://github.com/travis-ci/travis.rb):
```bash
git clone https://github.com/travis-ci/travis-build
cd travis-build
mkdir -p ~/.travis
ln -s $PWD ~/.travis/travis-build
gem install bundler
bundle install --gemfile ~/.travis/travis-build/Gemfile
bundler binstubs travis
```
You will now be able to run `travis compile`, which produces the bash script
that runs the specified job, except that the secure environment variables are
not defined, and that the build matrix expansion is not considered, e.g:
``` bash
~/.travis/travis-build/bin/travis compile
```
### _Important_
The bash script generated by the compile command contains commands that make changes
to the system on which it is executed (e.g., edit `/etc/resolv.conf`, install software).
Some require `sudo` privileges and they are not easily undone.
It is highly recommended that you run this in a container or other virtualized
environment.
### Invocation
The command can be invoked in 3 ways:
Without an argument, it produces and prints a bash script from the actions in
the local `.travis.yml` without considering `env` and `matrix` values
(`travis-build` is unable to expand these keys correctly).
``` bash
~/.travis/travis-build/bin/travis compile
```
With a single integer, it produces the script for the given build (or the first
job of that build matrix).
``` bash
~/.travis/travis-build/bin/travis compile 8
```
With an argument of the form `M.N`, it produces the bash script for the job
`M.N`.
``` bash
~/.travis/travis-build/bin/travis compile 351.2
```
The generated script can be used in a container or virtualized environment that
closely mimics Travis CI's build environment to aid you in debugging the build
failures. Instructions for running such a container are available
[in the Travis CI docs](https://docs.travis-ci.com/user/common-build-problems/#running-a-container-based-docker-image-locally).
## Raw CLI script
In addition to the travis CLI plugin you can also run the standalone CLI script:
``` bash
bundle exec script/compile < payload.json > build.sh
```
## Docker container
If you want to run travis-build locally on your machine (e.g. to interact with
[worker](https://github.com/travis-ci/worker)), you can also run it as a docker
container with docker-compose:
First, build the image:
``` bash
docker-compose build web
```
Second, run the image:
```bash
docker-compose run web
```
You may wish to run with a different setup for local development.
The following shows running `travis-build` in the `development`
environment, forwarding the Docker image's port 4000 to the host's
port 4000:
```bash
docker-compose run -e RACK_ENV=development -p 4000:4000 web
```
to build and run it. This will create a container with the contents of the `travis-build`
repository in the `/usr/src/app` directory, and start you off in that directory.
From there, you can run the commands listed in the [Use as addon for Travis CLI](#addon)
section to make the compile command available to Travis CLI within the container.
## License & copyright information
See [LICENSE](./LICENSE) file.
Copyright (c) 2011-2016 [Travis CI development
team](https://github.com/travis-ci).