CI/CD for Django

Hint

📚 Learn more about Django action features, integrations and alternatives.

With Buddy, you can create a pipeline that builds, tests, and deploys Django applications on a push to Git. The configuration is super simple and takes 10 to 15 minutes.

Image loading...Django pipeline exampleDjango pipeline example

1. Select your Git repository

Buddy supports all popular Git hosting providers, including GitHub, Bitbucket and GitLab. You can also use your own private Git server, or host code directly on Buddy.

Image loading...Supported Git providersSupported Git providers

2. Add a new delivery pipeline

Enter the pipeline's name, select the trigger mode, and define the branch from which Buddy will fetch your code:

Image loading...Exemplary pipeline settingsExemplary pipeline settings

Hint

Trigger modes

  • Manually (on click) — recommended for Production
  • On events (automatic) — recommended for Development
  • On schedule (on time interval) — recommended for Staging/Testing
Success
Event-based triggers allow you to run pipelines whenever a push is made to any branch in the repository, or whenever a branch, tag or a pull request is created or deleted. Image loading...On event pipeline trigger modeOn event pipeline trigger mode

3. Add actions

Buddy lets you choose from dozens of predefined actions. In this example, we'll add 4 actions that will perform the following tasks:

  • Download dependencies and run unit tests
  • Compile assets with Gulp
  • Upload code to server together with compiled assets
  • Send notification to Slack

3.1 Build your Django application

Success
Build actions in Buddy are run in isolated containers run from official Docker images. When the pipeline is run, Buddy pulls the container, runs build commands, and uploads the results to the pipeline filesystem.

Look up and click Django on the action list to add it to the pipeline:

Image loading...Action listAction list

The Run tab lets you determine the commands to execute. The default commands are:

pip install -r requirements.txt
python manage.py test$$

Image loading...Django commands consoleDjango commands console

3.1.2 Python version

You can change the version of Python and install missing packages & tools in the runtime environment tab:

Image loading...Python action imagePython action image

Tip
If your tests require a database to run, you can attach it in the Services tab: Image loading...Services tabServices tab

3.2 Run Gulp tasks

The next step is adding the Gulp action that will compile your assets and minify the code. To add a Gulp action, switch the tab to the Stacks section. You can find Gulp under Build Tools & Task Runners.

Image loading...Gulp selectionGulp selection

3.3 Deploy application to the server

The compiled application needs to be uploaded to the server. Head to the Transfer section and select your upload action (SFTP in our case):

Image loading...File transfer actionsFile transfer actions

When adding the action you can choose what and where should be uploaded:

Image loading...SFTP action configurationSFTP action configuration

3.4 Send notification to Slack

You can configure Buddy to send your team a message after the deployment. In this example we'll use Slack:

Image loading...Notification actionsNotification actions

Hint
If you add this action in the On Failure tab, Buddy will only send the message if something goes wrong with your build or deployment. Image loading... On failure notification On failure notification

4. Summary

Congratulations! You have just automated your entire delivery process. Make a push to the selected branch and watch Buddy fetch, build, and deploy your project. With Continuous Delivery applied, you can now focus on what's really important: developing awesome apps!

Last update:
Sep 23, 2024