> For the complete documentation index, see [llms.txt](https://ricardomol.gitbook.io/notes/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ricardomol.gitbook.io/notes/devops/ci/ci-with-django.md).

# CI with Django

Source: https\://www\.fullstackpython.com/continuous-integration.html

## Continuous Integration

**Automates the building, testing and deploying** of applications.

## Importance

CI can **dramatically reduce deployment times** by **minimizing steps that require human intervention**. 

Only minor downside: **it takes some initial time by a developer to set up** and then there is some **ongoing maintainence** if a project is broken into multiple parts, such as going from a monolith architecture to [microservices](https://www.fullstackpython.com/microservices.html).

## Automated testing

Another major **advantage of CI**.

**Broken deployments can be prevented** by running a comprehensive test suite of [unit](https://www.fullstackpython.com/unit-testing.html) and [integration tests](https://www.fullstackpython.com/integration-testing.html) when developers check in code to a source code repository.

Any bugs accidentally introduced during a check-in that are caught by the test suite are reported and **prevent the deployment** from proceeding.

## Continuous integration example

High level perspective on how CI and deployment can work

![One potential way for continuous integration to work with source control and a deployment environment.](https://www.fullstackpython.com/img/visuals/continuous-integration.png)

1. New **code is committed** to a source repository
2. A **hook that notifies the CI server** that new code needs to be built
3. The **CI server pulls the code to build and test** it
4. **If all tests pass**, the CI server begins the **deployment** process
5. The new code is pulled down to the server where the deployment is taking place
6. The deployment process is completed via **restarting services** and related deployment activities.

**There are many other ways** a CI server and its deployments can be structured. 

## Open source CI projects

Free and open source CI servers that are configurable based on a project's needs:

* [Jenkins](https://www.fullstackpython.com/jenkins.html) is a common CI server for building and deploying to test and production servers. [Jenkins source code is on GitHub](https://github.com/jenkinsci/jenkins).
* [Go CD](http://www.go.cd/) is a CI server by [ThoughtWorks](http://www.thoughtworks.com/) that was designed with best practices for the build and test & release cycles in mind. [Go CD source code is on GitHub](https://github.com/gocd/gocd).
* [BuildBot](http://buildbot.net/) is a continuous integration **framework** with a set of components for creating your own CI server. It's written in Python and intended for development teams that want more control over their build and deployment pipeline. [BuildBot source code is on GitHub](https://github.com/buildbot/buildbot).
* [TeamCity](https://www.jetbrains.com/teamcity/) is JetBrains' closed source CI server that requires a license to use.

## Jenkins CI resources

Commonly used as a **CI server** implementation for Python projects.

Open source and programming language agnostic.

Learn more via the following resources or on [the dedicated Jenkins page](https://www.fullstackpython.com/jenkins.html).

* My book on [deploying Python web applications](http://www.deploypython.com/) walks through every step of setting up a Jenkins project with a WSGI application to enable continuous delivery. Take a look if you're not grokking all of the steps provided in these other blog posts.
* [Assembling a continuous integration service for a Django project on Jenkins](https://medium.com/@mondaini/assembling-a-continuous-integration-service-for-a-django-project-on-jenkins-5f979d4c4184) shows how to set up a Ubuntu instance with a Jenkins server that'll build a [Django](https://www.fullstackpython.com/django.html) project.
* [Setting up Jenkins as a continuous integration server for Django](http://michal.karzynski.pl/blog/2014/04/19/continuous-integration-server-for-django-using-jenkins/) is another solid tutorial that also shows how to send email notifications as part of the build process.

## General CI resources

* [What is continuous integration?](http://martinfowler.com/articles/continuousIntegration.html) is a classic detailed article by Martin Fowler on the concepts behind CI and how to implement it.
* [Continuous Deployment For Practical People](http://www.airpair.com/continuous-deployment/posts/continuous-deployment-for-practical-people) is not specific to Python but a great read on what it entails.
* [Continuous Integration & Delivery - Illustrated](http://bitcubby.com/continuous-integration-delivery-illustrated/) uses well done drawings to show how continuous integration and delivery works for testing and managing data.
* [Diving into continuous integration as a newbie](http://www.rackspace.com/blog/diving-into-continuous-integration-as-a-newbie/) is a retrospective on learning CI from a Rackspace intern on how she learned the subject.
* [6 top continuous integration tools](https://opensource.com/business/15/7/six-continuous-integration-tools) gives a high level overview of six CI tools from a programming language agnostic perspective.
* [Updating the GOV.UK Continuous Integration environment](https://gdstechnology.blog.gov.uk/2017/02/10/updating-the-gov-uk-continuous-integration-environment/) explains the UK's Government Digital Service continuous integration configuration that relies on [Jenkins](https://www.fullstackpython.com/jenkins.html).
* [StackShare's Continuous Integration tag](http://stackshare.io/continuous-integration) lists a slew of hosted CI services roughly ranked by user upvotes.
* [Good practices for continuous integration](http://buildoutcoredev.readthedocs.org/en/latest/continous-integration.html) includes advice on checking in code, commit tests and reverting to previous revisions.
* [Scoring Continuous Integration](https://paulhammant.com/2017/05/01/scoring-continuous-integration/) gives an interesting perspective on ways to rank the effectiveness of how teams use their CI tooling.
* [Why Continuous Integration Is Important](https://blog.codeship.com/continuous-integration-important/) is a high-level overview of how CI can build trust both among developers and between developers and non-technical people in an organization. The post also discusses tasks related to setting up reliable CI such as test environments, [integration testing](https://www.fullstackpython.com/integration-testing.html) and visibility into the CI results.
* [Continuous Intrusion: Why CI tools are a hacker's best friend](https://www.blackhat.com/docs/eu-15/materials/eu-15-Mittal-Continuous-Intrusion-Why-CI-Tools-Are-An-Attackers-Best-Friend.pdf) (PDF) strongly advises securing your continuous integration server just as you would every other part of your production application, unless you want your environment to be vulnerable to malicious actors.
* [Measuring and Improving your CI/CD Pipelines](https://blog.petegoo.com/2018/11/09/optimizing-ci-cd-pipelines/) provides metrics for what you should measure with your CI/CD setup to improve the process for helping your development teams ship code.
* [Six rules for setting up continuous integration systems](https://rhonabwy.com/2016/01/31/six-rules-for-setting-up-continuous-integration-systems/) has some solid general advice for culling problematic tests, ensuring the integration speed supports the development culture you are building and keeping all code in source control instead of having complicated logic configured within the CI server.
* [How to Identify Major Blockers in a CI/CD Pipeline](https://blog.codeship.com/how-to-identify-major-blockers-in-a-cicd-pipeline/) gives a high level overview of concepts such as shipping velocity, test execution and environment provisioning with regards to CI configurations.