{"id":19210485,"url":"https://github.com/itchio/cigale","last_synced_at":"2025-11-13T19:02:46.754Z","repository":{"id":66881830,"uuid":"47073653","full_name":"itchio/cigale","owner":"itchio","description":":ant: Jenkins configuration generator","archived":false,"fork":false,"pushed_at":"2015-12-21T22:44:20.000Z","size":442,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-04T16:42:57.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itchio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-29T17:47:53.000Z","updated_at":"2024-03-28T18:08:50.000Z","dependencies_parsed_at":"2023-02-23T14:16:00.930Z","dependency_job_id":null,"html_url":"https://github.com/itchio/cigale","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itchio%2Fcigale","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itchio%2Fcigale/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itchio%2Fcigale/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itchio%2Fcigale/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itchio","download_url":"https://codeload.github.com/itchio/cigale/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240282946,"owners_count":19776793,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T13:36:14.566Z","updated_at":"2025-11-13T19:02:46.659Z","avatar_url":"https://github.com/itchio.png","language":"Ruby","readme":"# cigale\n\n![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)\n[![Build Status](https://travis-ci.org/itchio/cigale.svg)](https://travis-ci.org/itchio/cigale)\n[![Gem Version](https://badge.fury.io/rb/cigale.svg)](https://badge.fury.io/rb/cigale)\n\ncigale generates XML configuration that Jenkins can grok, from a bunch of\nhuman-readable, diff-friendly, YAML files.\n\nKey points:\n\n  * The source code should be human-readable\n  * Macros are just a YAML subtree that can be instanciated with\n  parameters of any types (scalars, sequences, etc.)\n\ncigale is used in production at [itch.io](http://itch.io/), and our\njob definitionso are a good comprehensive tour of:\n\n  * \u003chttps://github.com/itchio/ci.itch.ovh\u003e\n\n## Installation\n\nRun:\n\n```bash\ngem install cigale\n```\n\n## Usage\n\nThe `test` command generates XML files for you to inspect\n\n```bash\ncigale test spec/fixtures/parity/builders/fixtures/ant001.yaml -o tmp\n```\n\nThis would create the `./tmp` directory and generate XML files in there.\n\nYou can also specify a whole directory, in which case, cigale will parse\nthe whole directory recursively and generate all job definition it finds:\n\n```bash\ncigale test ci/jobs -o tmp\n```\n\nTo upload your job configuration to a running Jenkins instance\n\n## What can I use?\n\nYou can browse the `spec/fixtures/` directory to see what's possible.\n\nAnother good reference sources is the [Jenkins Job Builder documentation][jjbdoc],\nwhich cigale usually supports a superset of (at least in the categories listed\nin `spec/parity_spec.rb`)\n\n[jjbdoc]: (http://jenkins-job-builder.readthedocs.org/en/latest/definition.html)\n\n## Macros\n\nDefine a macro with a top-level element starting with `:`\n\n```yaml\n- :git-advanced:\n    git:\n      url: 'git@{host}:{user}/{name}.git'\n      credentials-id: 'some-credentials'\n      branches:\n        - '{branches}'\n```\n\nN.B: Always use quotes when using variable substitution, e.g. `'{a}'`, otherwise\nit'll be interpreted as a YAML object.\n\nUse a macro by having a subtree be an object whose only key is a dot followed\nby the macro's name:\n\n```yaml\n- job:\n    name: cigale\n    scm:\n      - .git:\n          host: github.com\n          user: itchio\n          name: cigale\n          branches: **\n```\n\nThe following will expand to:\n\n```yaml\n- job:\n    name: cigale\n    scm:\n      - git:\n          url: 'git@github.com:itchio/cigale.git'\n          credentials-id: 'some-credentials'\n          branches:\n            - '**'\n```\n\nIf you're unsure what something will expand to, you can use the `dump` command:\n\n```bash\ncigale dump my-def.yml -o tmp\n```\n\n## Splats\n\nSometimes you want to do this:\n\n```yaml\n- :cool-wrappers:\n    - ansi-color\n    - inject\n\n- job:\n    name: foobar\n    wrappers:\n      - .cool-wrappers:\n      - xvfb\n      \n```\n\nBut that will expand to:\n\n```yaml\n- job:\n    name: foobar\n    wrappers:\n      - - ansi-color\n        - inject\n      - xvfb\n```\n\nWhich isn't valid. What you want instead is use a splat when calling\ncool-wrappers (see [issue #2](https://github.com/itchio/cigale/issues/2))\n\n```yaml\n- job:\n    name: foobar\n    wrappers:\n      - ..cool-wrappers:\n      - xvfb\n```\n\nWhich will expand to the expected result:\n\n```yaml\n- job:\n    name: foobar\n    wrappers:\n      - ansi-color\n      - inject\n      - xvfb\n```\n\n## Contributing\n\n1. Fork it ( https://github.com/itchio/cigale/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License\n\ncigale is released under the MIT License.\n\nRead the `LICENSE.txt` file in this repository for more informations.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitchio%2Fcigale","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitchio%2Fcigale","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitchio%2Fcigale/lists"}