Projects as Code
Branch: master
Clone or download
Latest commit cace3ea Feb 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin bin Nov 12, 2018
ecology-api ecology-api Feb 18, 2019
ecology-core
ecology-io ecology-io Feb 18, 2019
ecology-json
framework Squashed all commits Jun 29, 2018
lib deps Feb 18, 2019
.gitignore Squashed all commits Jun 29, 2018
.gitmodules
.travis.yml .travis.yml Feb 18, 2019
LICENCE.md Squashed all commits Jun 29, 2018
README.md added project description to readme Oct 29, 2018

README.md

ecology Build Status

Description

Using a multi-repo approach in software development means you have smaller projects in bite sized portions for newcomers to digest, without having to ignore the noise of the other projects in a mono-repo. The problem with the multi-repo approach is the administrative overhead.

ecology is a tool for eliminating the administrative overhead of setting up new repos, configuring & maintaining CI and a way to reduce CIaaS [TravisCI, CircleCI, Bitbucket Pipelines] boilerplate.

The boring menial work that ecology automates is replaced with a streamlined collaboration process to determine whether the project should exist or not.

ecology is an Haskell application. The definition of EcologyProject is here. You'll find an example ecology template for a multiproject haskell project here

TL;DR

Manages and tracks an ecology of projects

More

Why

I want to be able to create lots of repos for fast experimentation, modularity of work and sharing of code.

Couple of problems with it:

  1. Its slow to create new repos
    • Create the repo
    • Bootstrap it for the given language
    • Setup CI for it (TravisCI, CircleCI, Bitbucket pipelines, etc...)
    • Setup notifications for it (slack/hipchat/etc...)
  2. Have to manage those repos
    • e.g. change in slack/hipchat creds?
      • With TravisCI, creds are configured per repo, have 100 projects? Those are configured on a per repo basis, its going to be a long day.
    • update a template?
      • We don't want to have to go through and manually merge it through, at the very least we want automated attempts to happen with PRs raised.
      • Ultimately we want to be able to cope without having to update projects on template changes at all.
      • Same is true of any change really, be nice if we could provide a script to run and have it traverse the desired repos, make the changes and raise a PR on it for me to look at.
  3. Documentation
    • When you have lots of repos it becomes easy to get lost. It would be nice to be able to generate a static site that says what a project is, and who are the "experts" in that project etc...
    • No project naming standards. In practice they end up resulting in long names for projects that you never remember off the top of your head when looking. We like our project names short and punchy, but would like to be able to search for a project by "what it is" via tags.

Ecology

Projects as Code.

API keys stored in AWS SMS parameter store, Ecology will sync them across projects that share the same parameters.

Changes are shot out to all projects on updates.

When new projects are detected, new repos are created on GitHub/Bitbucket, CI is setup for them, and any other special things (e.g. Docker Hub repos) are setup for them.

More documentation to come.

See Also

Building the lot

bin/ci.common

Building the projects

Each project can be built with the command:

./mafia build

The first time you ever run it on your system it might take a while, as it will build and install haskell-mafia/mafia on your system.

Running the tests

./mafia test