Skip to content

Commit e74a8d7

Browse files
igor-alexandrovigor-alexandrov
authored
Added Configure GitHub Actions step to the Python guide (#22676)
## Description Replaced "Configure CI/CD" step of the Python guide with "Configure GitHub Actions" step to have it similar structure as the Rails guide. ## Related issues or tickets #22114 ## Reviews - [ ] Technical review - [x] Editorial review - [ ] Product review
1 parent 659c547 commit e74a8d7

File tree

5 files changed

+118
-139
lines changed

5 files changed

+118
-139
lines changed

‎content/guides/python/configure-ci-cd.md‎

Lines changed: 0 additions & 133 deletions
This file was deleted.

‎content/guides/python/configure-github-actions.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
title: Automate your builds with GitHub Actions
3+
linkTitle: Automate your builds with GitHub Actions
4+
weight: 20
5+
keywords: ci/cd, github actions, python, flask
6+
description: Learn how to configure CI/CD using GitHub Actions for your Python application.
7+
aliases:
8+
- /language/python/configure-ci-cd/
9+
- /guides/language/python/configure-ci-cd/
10+
- /guides/python/configure-ci-cd/
11+
---
12+
13+
## Prerequisites
14+
15+
Complete all the previous sections of this guide, starting with [Containerize a Python application](containerize.md). You must have a [GitHub](https://github.com/signup) account and a [Docker](https://hub.docker.com/signup) account to complete this section.
16+
17+
If you didn't create a [GitHub repository](https://github.com/new) for your project yet, it is time to do it. After creating the repository, don't forget to [add a remote](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories) and ensure you can commit and [push your code](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) to GitHub.
18+
19+
1. In your project's GitHub repository, open **Settings**, and go to **Secrets and variables** > **Actions**.
20+
21+
2. Under the **Variables** tab, create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as a value.
22+
23+
3. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write.
24+
25+
4. Add the PAT as a **Repository secret** in your GitHub repository, with the name
26+
`DOCKERHUB_TOKEN`.
27+
28+
## Overview
29+
30+
GitHub Actions is a CI/CD (Continuous Integration and Continuous Deployment) automation tool built into GitHub. It allows you to define custom workflows for building, testing, and deploying your code when specific events occur (e.g., pushing code, creating a pull request, etc.). A workflow is a YAML-based automation script that defines a sequence of steps to be executed when triggered. Workflows are stored in the `.github/workflows/` directory of a repository.
31+
32+
In this section, you'll learn how to set up and use GitHub Actions to build your Docker image as well as push it to Docker Hub. You will complete the following steps:
33+
34+
1. Define the GitHub Actions workflow.
35+
2. Run the workflow.
36+
37+
## 1. Define the GitHub Actions workflow
38+
39+
You can create a GitHub Actions workflow by creating a YAML file in the `.github/workflows/` directory of your repository. To do this use your favorite text editor or the GitHub web interface. The following steps show you how to create a workflow file using the GitHub web interface.
40+
41+
If you prefer to use the GitHub web interface, follow these steps:
42+
43+
1. Go to your repository on GitHub and then select the **Actions** tab.
44+
45+
2. Select **set up a workflow yourself**.
46+
47+
This takes you to a page for creating a new GitHub Actions workflow file in
48+
your repository. By default, the file is created under `.github/workflows/main.yml`, let's change it name to `build.yml`.
49+
50+
If you prefer to use your text editor, create a new file named `build.yml` in the `.github/workflows/` directory of your repository.
51+
52+
Add the following content to the file:
53+
54+
```yaml
55+
name: Build and push Docker image
56+
57+
on:
58+
push:
59+
branches:
60+
- main
61+
62+
jobs:
63+
build_and_push:
64+
runs-on: ubuntu-latest
65+
steps:
66+
- name: Login to Docker Hub
67+
uses: docker/login-action@v3
68+
with:
69+
username: ${{ vars.DOCKER_USERNAME }}
70+
password: ${{ secrets.DOCKERHUB_TOKEN }}
71+
72+
- name: Set up Docker Buildx
73+
uses: docker/setup-buildx-action@v3
74+
75+
- name: Build and push
76+
uses: docker/build-push-action@v6
77+
with:
78+
push: true
79+
tags: ${{ vars.DOCKER_USERNAME }}/${{ github.event.repository.name }}:latest
80+
```
81+
82+
Each GitHub Actions workflow includes one or several jobs. Each job consists of steps. Each step can either run a set of commands or use already [existing actions](https://github.com/marketplace?type=actions). The action above has three steps:
83+
84+
1. [**Login to Docker Hub**](https://github.com/docker/login-action): Action logs in to Docker Hub using the Docker ID and Personal Access Token (PAT) you created earlier.
85+
86+
2. [**Set up Docker Buildx**](https://github.com/docker/setup-buildx-action): Action sets up Docker [Buildx](https://github.com/docker/buildx), a CLI plugin that extends the capabilities of the Docker CLI.
87+
88+
3. [**Build and push**](https://github.com/docker/build-push-action): Action builds and pushes the Docker image to Docker Hub. The `tags` parameter specifies the image name and tag. The `latest` tag is used in this example.
89+
90+
## 2. Run the workflow
91+
92+
Let's commit the changes, push them to the `main` branch. In the workflow above, the trigger is set to `push` events on the `main` branch. This means that the workflow will run every time you push changes to the `main` branch. You can find more information about the workflow triggers [here](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
93+
94+
Go to the **Actions** tab of you GitHub repository. It displays the workflow. Selecting the workflow shows you the breakdown of all the steps.
95+
96+
When the workflow is complete, go to your [repositories on Docker Hub](https://hub.docker.com/repositories). If you see the new repository in that list, it means the GitHub Actions workflow successfully pushed the image to Docker Hub.
97+
98+
## Summary
99+
100+
In this section, you learned how to set up a GitHub Actions workflow for your Python application.
101+
102+
Related information:
103+
104+
- [Introduction to GitHub Actions](/guides/gha.md)
105+
- [Docker Build GitHub Actions](/manuals/build/ci/github-actions/_index.md)
106+
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
107+
108+
## Next steps
109+
110+
In the next section, you'll learn how you can develop your application using containers.
111+

‎content/guides/python/containerize.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -375,5 +375,6 @@ Related information:
375375

376376
## Next steps
377377

378-
In the next section, you'll learn how you can develop your application using
379-
containers.
378+
In the next section, you'll take a look at how to set up a CI pipeline using GitHub Actions.
379+
380+

‎content/guides/python/deploy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ data:
9898
In your `python-docker-dev-example` directory, create a file named
9999
`docker-python-kubernetes.yaml`. Replace `DOCKER_USERNAME/REPO_NAME` with your
100100
Docker username and the repository name that you created in [Configure CI/CD for
101-
your Python application](./configure-ci-cd.md).
101+
your Python application](./configure-github-actions.md).
102102

103103
```yaml
104104
apiVersion: apps/v1
@@ -158,7 +158,7 @@ In these Kubernetes YAML file, there are various objects, separated by the `---`
158158
you'll get just one replica, or copy of your pod. That pod, which is
159159
described under `template`, has just one container in it. The
160160
container is created from the image built by GitHub Actions in [Configure CI/CD for
161-
your Python application](configure-ci-cd.md).
161+
your Python application](configure-github-actions.md).
162162
- A Service, which will define how the ports are mapped in the containers.
163163
- A PersistentVolumeClaim, to define a storage that will be persistent through restarts for the database.
164164
- A Secret, Keeping the database password as an example using secret kubernetes resource.

‎content/guides/python/develop.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Use containers for Python development
33
linkTitle: Develop your app
4-
weight: 20
4+
weight: 40
55
keywords: python, local, development
66
description: Learn how to develop your Python application locally.
77
aliases:
@@ -569,4 +569,4 @@ Related information:
569569

570570
## Next steps
571571

572-
In the next section, you'll take a look at how to set up a CI/CD pipeline using GitHub Actions.
572+
In the next section, you'll learn how you can locally test and debug your workloads on Kubernetes before deploying.

0 commit comments

Comments
 (0)