Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itchio/cigale
:ant: Jenkins configuration generator
https://github.com/itchio/cigale
Last synced: about 2 months ago
JSON representation
:ant: Jenkins configuration generator
- Host: GitHub
- URL: https://github.com/itchio/cigale
- Owner: itchio
- License: mit
- Created: 2015-11-29T17:47:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-21T22:44:20.000Z (about 9 years ago)
- Last Synced: 2024-05-02T06:11:08.420Z (8 months ago)
- Language: Ruby
- Homepage:
- Size: 432 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# cigale
[](https://travis-ci.org/itchio/cigale)
[](https://badge.fury.io/rb/cigale)
cigale generates XML configuration that Jenkins can grok, from a bunch of
human-readable, diff-friendly, YAML files.
Key points:
* The source code should be human-readable
* Macros are just a YAML subtree that can be instanciated with
parameters of any types (scalars, sequences, etc.)
cigale is used in production at [itch.io](http://itch.io/), and our
job definitionso are a good comprehensive tour of:
*
## Installation
Run:
```bash
gem install cigale
```
## Usage
The `test` command generates XML files for you to inspect
```bash
cigale test spec/fixtures/parity/builders/fixtures/ant001.yaml -o tmp
```
This would create the `./tmp` directory and generate XML files in there.
You can also specify a whole directory, in which case, cigale will parse
the whole directory recursively and generate all job definition it finds:
```bash
cigale test ci/jobs -o tmp
```
To upload your job configuration to a running Jenkins instance
## What can I use?
You can browse the `spec/fixtures/` directory to see what's possible.
Another good reference sources is the [Jenkins Job Builder documentation][jjbdoc],
which cigale usually supports a superset of (at least in the categories listed
in `spec/parity_spec.rb`)
[jjbdoc]: (http://jenkins-job-builder.readthedocs.org/en/latest/definition.html)
## Macros
Define a macro with a top-level element starting with `:`
```yaml
- :git-advanced:
git:
url: 'git@{host}:{user}/{name}.git'
credentials-id: 'some-credentials'
branches:
- '{branches}'
```
N.B: Always use quotes when using variable substitution, e.g. `'{a}'`, otherwise
it'll be interpreted as a YAML object.
Use a macro by having a subtree be an object whose only key is a dot followed
by the macro's name:
```yaml
- job:
name: cigale
scm:
- .git:
host: github.com
user: itchio
name: cigale
branches: **
```
The following will expand to:
```yaml
- job:
name: cigale
scm:
- git:
url: '[email protected]:itchio/cigale.git'
credentials-id: 'some-credentials'
branches:
- '**'
```
If you're unsure what something will expand to, you can use the `dump` command:
```bash
cigale dump my-def.yml -o tmp
```
## Splats
Sometimes you want to do this:
```yaml
- :cool-wrappers:
- ansi-color
- inject
- job:
name: foobar
wrappers:
- .cool-wrappers:
- xvfb
```
But that will expand to:
```yaml
- job:
name: foobar
wrappers:
- - ansi-color
- inject
- xvfb
```
Which isn't valid. What you want instead is use a splat when calling
cool-wrappers (see [issue #2](https://github.com/itchio/cigale/issues/2))
```yaml
- job:
name: foobar
wrappers:
- ..cool-wrappers:
- xvfb
```
Which will expand to the expected result:
```yaml
- job:
name: foobar
wrappers:
- ansi-color
- inject
- xvfb
```
## Contributing
1. Fork it ( https://github.com/itchio/cigale/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License
cigale is released under the MIT License.
Read the `LICENSE.txt` file in this repository for more informations.