Skip to content

Latest commit

 

History

History
93 lines (74 loc) · 4.36 KB

README.md

File metadata and controls

93 lines (74 loc) · 4.36 KB
Raw

Alloy CI

build status Docker Coverage Status

AlloyCI is a Continuous Integration, Deployment, and Delivery coordinator, written in Elixir, that takes advantage of the GitLab CI Runner, and its capabilities as executor. It also provides its own runner, the Alloy Runner, which is a fork of the GitLab CI Runner, with extra capabilities.

It aims to bridge the gap between GitLab's CI runner and GitHub. GitLab's CI runner is tightly coupled with GitLab, so it is not possible to use one of these runners from a GitHub codebase.

With AlloyCI you will be able to register one of the Runner projects to the platform, connect it to one of your GitHub repositories, and have it run your CI and CD pipelines.

AlloyCI will report the status of your pipelines to your pull requests, branches, and commits, so you can always know their status, just like any other CI service.

Goals

  • To provide a clean bridge between GitHub and the GitLab CI runner
  • To provide an alternative to other open source CI services
  • To leverage the great open source project that is the GitLab CI runner
  • To provide GitHub users with the same top class CI/CD that GitLab has, without having to switch to, or use GitLab, or paying insane amounts for inferior services

Stretch Goals

  • To provide all the CI/CD/Pipelines functionality, currently available only to GitLab EE, for free
  • To create a SaaS based on AlloyCI and provide a more cost effective alternative to the current CI service ecosystem

Features

  • Basic CI functionality:
    • Uses the .alloy-ci.yml to define pipelines, jobs, and stages
    • Can send the required build information to the runner for processing when requested
    • Can receive status updates from runner
    • Can report back to GitHub with the statuses
    • Can send notifications via email with the status of a pipeline
    • Can send notifications to Slack with the status of a pipeline
  • Extras
    • Build statistics per project
    • Build statistics per runner
    • Support for GitHub Enterprise
  • Advanced CI functionality
    • Can run jobs on multiple environments (using the image feature of the Docker executor.)
    • Can use a local build cache to speed up jobs
    • Can build and test from pull requests coming from a fork
    • Can distinguish between tags and branches
    • Can make use of only and except tags for jobs
    • Can make use of secret variables stored on a per project basis
    • Can receive uploaded artifacts from runners
    • Can pass artifacts between build jobs as dependencies
    • Can manually specify dependent jobs via the .alloy-ci.yml file
    • Presents the artifacts to the user in a nice way, and allows download
  • Deployment functionality
    • Can manually start deployments (manual actions)
    • Can do auto deploys
    • Can make use of different environments
    • Can start Review Apps
  • Auto Scaling Support (supported directly by the runner)
    • Can create runners on demand
    • Can destroy runners when not in use

Installation

Head over to our documentation for more information.

Contributing

Pull requests are always welcome!

  1. Clone the Repository
  2. Run mix deps.get to install all dependencies
  3. Run cd assets && yarn install to install all Javascript dependencies
  4. Make sure all environment variables are present. See here for more info. You can save them in a .env file, and source them before running any mix task
  5. Create and migrate the database with mix ecto.setup
  6. Run tests with make unit or start a development server with make run
  7. Code & send your PR when ready

Before contributing, please read our Code of Conduct and make sure you fully understand it. Violations will not be tolerated.

Copyright

Copyright (c) 2018 Patricio Cano. See LICENSE for details.