Einrichten der kontinuierlichen Bereitstellung in einem GitHub-Repository

Diese Übersetzung wurde von einer generativen KI mithilfe von Action Continuous Translation erstellt. →

A beautiful cover image with the text "Github CD"

28.07.2024 • 3 min Lesezeit • 500 Wörter

Im heutigen Beitrag werfen wir einen kurzen Blick darauf, wie man eine kontinuierliche Bereitstellung in einem GitHub-Repository einrichtet. Wir sind uns ziemlich sicher, dass dieses Setup auch mit anderen Git-Registrys funktioniert. Beachten Sie jedoch, dass sich dieser Beitrag ausschließlich auf GitHub konzentriert.

Dieser Beitrag setzt voraus, dass Sie GitHub-Actions in Kombination mit Argo CD verwenden, um Ihre Anwendungen auf einem Kubernetes-Cluster bereitzustellen. Folgen Sie unseren anderen Bereitstellungsbeiträgen, um weitere Anleitungen zur Einrichtung beider Technologien auf Ihrem persönlichen Server zu erhalten.

Vorbereitungen

Wir empfehlen, ein Docker Hub-Konto zu erstellen oder ein anderes Docker-Registry Ihrer Wahl zu nutzen.

Ihr GitHub-Repository muss die folgenden Bedingungen erfüllen:

Hat eine Dockerfile (idealerweise im Stammordner)
Hat zwei GitHub-Secrets (GitHub-Secret erstellen):
- DOCKER\_USERNAME: Ihr Docker-Benutzername
- DOCKER_PASSWORD: Ihr Docker-Passwort (oder Access Token)

Erstellen einer Workflow-Datei (oder mehrerer)

GitHub Actions sind spezielle Jobs in GitHub, die meist auf Linux-Servern ausgeführt werden und über das Erstellen von yaml-Dateien im Verzeichnis .github/workflows gesteuert werden können. Diese speziellen Dateien können festlegen, nach welchen Ereignissen diese Jobs ausgeführt werden sollen, und bieten Ihnen viel Freiheit. Als regelmäßiger GitHub-Actions-Nutzer kann ich Ihnen sagen, dass Sie sich daran gewöhnen sollten, Ihre yaml-Dateien ziemlich oft umzuschreiben, da Sie häufig kleine Details übersehen. Aber ohne weitere Umschweife, lassen Sie uns direkt in die Erstellung einer passenden deployment.yaml-Datei einsteigen, die einige Aufgaben für uns erledigt:

Eine neue Docker-Image-Version in Docker Hub hochladen (mit der neuesten Version).
Die manifest/deployment.yaml-Datei aktualisieren, damit Argo CD über das neue getaggte Image informiert wird.
(optional) Ein neues Release auf GitHub erstellen, damit die Zeitpunkte der Releases dokumentiert sind, wo sie sein sollten.

1
name: Deployment
2

3
on:
4
    push:
5
        branches: [main]
6
    merge_group:
7
    pull_request:
8
        branches: [main]
9
    # Allows you to run this workflow manually from the Actions tab
10
    workflow_dispatch:
11

12
# Automatically cancel in-progress actions on the same branch
13
concurrency:
14
    group: ${{ github.workflow }}-${{ github.event_name == 'pull_request_target' && github.head_ref || github.ref }}
15
    cancel-in-progress: true
16

17
env:
18
    REGISTRY: docker.io
19
    IMAGE_NAME: trueberryless/blog
20
    NODE_VERSION: 20
21

22
jobs:
23
    deployment:
24
        if: contains(github.event.head_commit.message, 'deploy') || github.event_name == 'workflow_dispatch'
25
        runs-on: ubuntu-latest
26
        permissions:
27
            contents: write
28
        steps:
29
            - name: Check out the repo
30
              uses: actions/checkout@v4
31
              with:
32
                  fetch-depth: 0
33

34
            - name: Create tag
35
              run: echo "IMAGE_TAG=$(echo $GITHUB_REF_NAME-$GITHUB_SHA)" >> $GITHUB_ENV
36

37
            - name: Set up Docker Buildx
38
              uses: docker/setup-buildx-action@v2
39

40
            - name: Log in to Docker Hub
41
              uses: docker/login-action@v2
42
              with:
43
                  username: ${{ secrets.DOCKER_USERNAME }}
44
                  password: ${{ secrets.DOCKER_PASSWORD }}
45

46
            - name: Extract metadata (tags, labels) for Docker
47
              id: meta
48
              uses: docker/metadata-action@v4
49
              with:
50
                  images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
51

52
            - name: Build and push Docker image
53
              uses: docker/build-push-action@v5
54
              with:
55
                  context: .
56
                  push: true
57
                  tags: |
58
                      ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}
59
                      ${{ env.IMAGE_NAME }}:latest
60
                  labels: ${{ steps.meta.outputs.labels }}
61

62
            - name: Update deployment.yaml file
63
              run: |
64
                  yq eval '.spec.template.spec.containers[0].image = "${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}"' -i manifest/deployment.yaml
65

66
            - uses: stefanzweifel/git-auto-commit-action@v4
67
              with:
68
                  commit_message: update deployment.json container image (automated)
69

70
            - uses: ncipollo/release-action@v1
71
              with:
72
                  tag: ${{ env.IMAGE_TAG }}
73
                  makeLatest: true
74
                  body: "A docker image has been deployed to [Docker Hub](https://hub.docker.com/r/${{ env.IMAGE_NAME }}/tags)."

Hier finden Sie eine veraltete docker-hub.yaml, die wir früher verwendet haben, da sie gute Versionierungsstrategien bietet:


144 ausgeblendete Zeilen
1
name: Docker Image Push
2

3
on:
4
    push:
5
        branches: [main]
6
    merge_group:
7
    pull_request:
8
        branches: [main]
9
    # Allows you to run this workflow manually from the Actions tab
10
    workflow_dispatch:
11

12
# Automatically cancel in-progress actions on the same branch
13
concurrency:
14
    group: ${{ github.workflow }}-${{ github.event_name == 'pull_request_target' && github.head_ref || github.ref }}
15
    cancel-in-progress: true
16

17
env:
18
    REGISTRY: docker.io
19
    IMAGE_NAME: trueberryless/blog
20
    NODE_VERSION: 18
21

22
jobs:
23
    docker-push-image:
24
        if: contains(github.event.head_commit.message, 'version') || github.event_name == 'workflow_dispatch'
25
        runs-on: ubuntu-latest
26
        permissions:
27
            contents: write
28
        steps:
29
            - name: Check out the repo
30
              uses: actions/checkout@v4
31
              with:
32
                  fetch-depth: 0
33

34
            - name: Check if file exists
35
              run: |
36
                  if [ -f .github/artifacts/version.json ]; then
37
                    echo "File exists"
38
                    echo "FILE_EXISTS=true" >> $GITHUB_ENV
39
                  else
40
                    echo "File does not exist"
41
                    echo "FILE_EXISTS=false" >> $GITHUB_ENV
42
                  fi
43

44
            - name: read_json
45
              if: ${{ env.FILE_EXISTS == 'true' }}
46
              id: version
47
              uses: zoexx/github-action-json-file-properties@release
48
              with:
49
                  file_path: ".github/artifacts/version.json"
50

51
            - name: save environment variables
52
              if: ${{ env.FILE_EXISTS == 'true' }}
53
              run: |
54
                  echo "MAJOR=${{steps.version.outputs.major}}" >> $GITHUB_ENV
55
                  echo "MINOR=${{steps.version.outputs.minor}}" >> $GITHUB_ENV
56
                  echo "PATCH=${{steps.version.outputs.patch}}" >> $GITHUB_ENV
57

58
            - name: create environment variables
59
              if: ${{ env.FILE_EXISTS == 'false' }}
60
              run: |
61
                  echo "MAJOR=0" >> $GITHUB_ENV
62
                  echo "MINOR=0" >> $GITHUB_ENV
63
                  echo "PATCH=0" >> $GITHUB_ENV
64

65
            - name: echo environment variables
66
              run: |
67
                  echo ${{ env.MINOR }}
68
                  echo ${{ env.MINOR }}
69
                  echo ${{ env.MINOR }}
70

71
            - name: Major version
72
              if: contains(github.event.head_commit.message, 'major')
73
              run: |
74
                  echo "New major version"
75
                  echo "MAJOR=$((${{ env.MAJOR }}+1))" >> $GITHUB_ENV
76
                  echo "MINOR=0" >> $GITHUB_ENV
77
                  echo "PATCH=0" >> $GITHUB_ENV
78

79
            - name: Minor version
80
              if: contains(github.event.head_commit.message, 'minor')
81
              run: |
82
                  echo "New minor version"
83
                  echo "MINOR=$((${{ env.MINOR }}+1))" >> $GITHUB_ENV
84
                  echo "PATCH=0" >> $GITHUB_ENV
85

86
            - name: Patch version
87
              if: contains(github.event.head_commit.message, 'patch') || github.event_name == 'workflow_dispatch'
88
              run: |
89
                  echo "New patch version"
90
                  echo "PATCH=$((${{ env.PATCH }}+1))" >> $GITHUB_ENV
91

92
            - name: Set up Docker Buildx
93
              uses: docker/setup-buildx-action@v2
94

95
            - name: Log in to Docker Hub
96
              uses: docker/login-action@v2
97
              with:
98
                  username: ${{ secrets.DOCKER_USERNAME }}
99
                  password: ${{ secrets.DOCKER_PASSWORD }}
100

101
            - name: Extract metadata (tags, labels) for Docker
102
              id: meta
103
              uses: docker/metadata-action@v4
104
              with:
105
                  images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
106

107
            - name: Build and push Docker image
108
              uses: docker/build-push-action@v5
109
              with:
110
                  context: .
111
                  push: true
112
                  tags: |
113
                      ${{ env.IMAGE_NAME }}:${{ env.MAJOR }}.${{ env.MINOR }}.${{ env.PATCH }}
114
                      ${{ env.IMAGE_NAME }}:latest
115
                  labels: ${{ steps.meta.outputs.labels }}
116

117
            - name: Check out the repo
118
              uses: actions/checkout@v4
119
              with:
120
                  fetch-depth: 0
121

122
            - name: Create folder if necessary
123
              if: ${{ env.FILE_EXISTS == 'false' }}
124
              run: mkdir -p .github/artifacts
125

126
            - name: write_json
127
              id: create-json
128
              uses: jsdaniell/create-json@v1.2.2
129
              with:
130
                  name: "version.json"
131
                  json: '{ "major": ${{ env.MAJOR }}, "minor": ${{ env.MINOR }}, "patch": ${{ env.PATCH }} }'
132
                  dir: ".github/artifacts/"
133

134
            - uses: stefanzweifel/git-auto-commit-action@v4
135
              with:
136
                  commit_message: update version.json (automated)
137

138
            - name: Update deployment.yaml file
139
              run: |
140
                  yq eval '.spec.template.spec.containers[0].image = "${{ env.IMAGE_NAME }}:${{ env.MAJOR }}.${{ env.MINOR }}.${{ env.PATCH }}"' -i manifest/deployment.yaml
141

142
            - uses: stefanzweifel/git-auto-commit-action@v4
143
              with:
144
                  commit_message: update deployment.json container image (automated)

Nachdem Sie den Inhalt unserer deployment.yaml-Datei kopiert und die neue Datei im .github/workflows-Ordner erstellt haben, müssen Sie einige sehr wichtige Anpassungen vornehmen:

Ändern Sie den IMAGE_NAME in Ihr persönliches Docker Hub-Repository. Der Bildname besteht aus Ihrem Kontonamen und dem Repositoriesnamen. Wenn Sie sich nicht sicher sind, wie Ihr Bildname lautet, können Sie die URL des Docker Hub-Repositories ansehen, dort sollte er irgendwo zu finden sein.

Jetzt sollten Sie bereit sein, das Schlüsselwort deploy in jede Commit-Nachricht für den Hauptzweig Ihres Repositories einzufügen, und es sollte automatisch ein Docker-Image an Docker Hub senden und das Manifest für Argo CD aktualisieren.

Feiern Sie mit einem Kaffee!

Herzlichen Glückwunsch, Sie haben Argo CD erfolgreich mit k3s und Cilium eingerichtet! Sie haben eine Kaffeepause verdient. Genießen Sie eine wohlverdiente Tasse, und wenn Sie mit mir einen virtuellen Kaffee teilen möchten, können Sie gerne meine Arbeit auf Ko-fi unterstützen. Vielen Dank!