https://github.com/simonsdave/dev-env

Simplify automated development environment provisioning
https://github.com/simonsdave/dev-env

automation developer-tools

Last synced: 5 months ago
JSON representation

Simplify automated development environment provisioning

• Host: GitHub
• URL: https://github.com/simonsdave/dev-env
• Owner: simonsdave
• License: mit
• Archived: true
• Created: 2017-08-17T00:20:37.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-10-23T14:16:35.000Z (over 3 years ago)
• Last Synced: 2025-10-27T04:35:18.645Z (8 months ago)
• Topics: automation, developer-tools
• Language: Shell
• Homepage:
• Size: 802 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# dev-env

![Maintained](https://img.shields.io/maintenance/yes/2022.svg?style=flat)

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

![PythonVersions](https://img.shields.io/pypi/pyversions/dev-env.svg?style=flat)

![status](https://img.shields.io/pypi/status/dev-env.svg?style=flat)

[![PyPI](https://img.shields.io/pypi/v/dev-env.svg?style=flat)](https://pypi.python.org/pypi/dev-env)

[![CodeFactor](https://www.codefactor.io/repository/github/simonsdave/dev-env/badge/master)](https://www.codefactor.io/repository/github/simonsdave/dev-env/overview/master)

[![CircleCI](https://circleci.com/gh/simonsdave/dev-env/tree/master.svg?style=shield)](https://circleci.com/gh/simonsdave/dev-env/tree/master)

[![codecov](https://codecov.io/gh/simonsdave/dev-env/branch/master/graph/badge.svg)](https://codecov.io/gh/simonsdave/dev-env/branch/master)

[![docker-simonsdave/bionic-dev-env](https://img.shields.io/badge/docker-simonsdave%2Fbionic--dev--env-blue.svg)](https://hub.docker.com/r/simonsdave/bionic-dev-env/)

This repo was originally created as a way to centralize

and document the process of provisioning development environments (dev env).

As time went on it became clear that it would be helpful to

centralize other common development tools and utilities.

This repo now contains tools, scripts and utilities which:

* provision dev and CI environments using [Docker](https://www.docker.com/) with confidence that both the development and CI environments are the same

* automate cutting releases

* simplify integration testing

The tools, scripts and utilities in this repo assume the user follows a pre-defined set of patterns and practices.

## Key Concepts

* a project is hosted in either public or private github repo

* at the project's root is a text file called ```cfg4dev``` which configures the project's dev env

* after git cloning the repo, a developer configures the dev env by executing ```source cfg4dev```

* ```dev-env``` publishes dev env docker images to [Docker Hub](https://hub.docker.com/)

* the docker images are docker pulled to a developer's machine by ```cfg4dev```

* [CircleCI](https://www.circleci.com) can use a ```dev-env``` docker image as a [docker executor](https://circleci.com/docs/2.0/executor-types/#using-docker)

* [shell and python scripts](bin) are run on a developer's machine to access the dev env packaged in the docker image

* the scripts are installed on a developer's machine by ```cfg4dev```

* at the project's root is a text file called ```CHANGELOG.md``` which is manually curated by developers to record key changes to the project

## Assumptions

* developers use [macOS](https://www.apple.com/ca/macos/)

* ```dev-env``` targets projects which are shell and Python centric

* if a project's repo is called ```abc-def-ghi``` and the project builds

  a Python package, the package is called ```abc_def_ghi``` and the source

  code for the package is in a sub-directory of the project's root directory

  called ```abc_def_ghi``` - in addition, the ```abc_def_ghi``` directory

  contains a file called ```__init__.py``` that contains at least a single

  line that looks like ```__version__ = '1.2.0'``` which declares the Python

  package version

* scripts and Dockerfiles to build a project's development environment

  are in a sub-directory of the project's root directory called ```dev_env```

* projects use a branching strategy something like

  * all development is done on the ```master``` branch (optionally using [feature branches](https://guides.github.com/introduction/flow/))

  * use [Semantic Versioning](http://semver.org/)

  * for each release a new branch is created from master called ```release-```

* ```CHANGELOG.md``` follows a predefined format / structure

## What Next

* take a look at the [shell and python scripts](bin) to assess ```dev-env``` capability

* [here's](docs/using.md) a description of how to start using ```dev-env```

* take a look at [this](https://github.com/simonsdave/dev-env-testing) github repo which illustrates how to use ```dev-env```

* if you'd like to help contribute to ```dev-env``` see [this](docs/contributing.md)

## References/Inspirations

* [21 Nov '18 - How to fully utilise Docker during development](https://medium.com/tsftech/how-to-fully-utilise-docker-during-development-42bb3cdc3017)

* [semantic-release - fully automated version management and package publishing](https://github.com/semantic-release/semantic-release)