Sign commits with GitPython package

.env.template

@@ -1,2 +1,4 @@
 # https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
-INPUT_REPO_TOKEN=XXX
+INPUT_REPO_TOKEN=XX
+GPG_PRIVATE_KEY=-----BEGIN PGP PRIVATE KEY BLOCK-----\n\nlXX\n-----END PGP PRIVATE KEY BLOCK-----\n
+PASSPHRASE=XX

.github/workflows/example-01.yml

@@ -1,10 +1,8 @@
 name: Test workflow for example 01
 
 on:
-  schedule:
-    - cron:  '0 0 * * *'
   push:
-    branches: [ main ]
+    branches: [ main, issue-* ]
 
 jobs:
   import:
@@ -19,5 +17,4 @@ jobs:
         run: |
           docker run --rm \
             --env INPUT_REPO_TOKEN=${{ secrets.GITHUB_TOKEN }} \
-            pygithub \
-            python 01_sign_commit_using_github_api.py
+            pygithub src/01_sign_commit_using_github_api.py

.github/workflows/example-02.yml

@@ -1,10 +1,8 @@
 name: Test workflow for example 02
 
 on:
-  schedule:
-    - cron:  '0 0 * * *'
   push:
-    branches: [ main ]
+    branches: [ main, issue-* ]
 
 jobs:
   import:

.github/workflows/example-03.yml

@@ -0,0 +1,24 @@
+name: Test workflow for example 03
+
+on:
+  push:
+    branches: [ main, issue-* ]
+
+jobs:
+  import:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build docker image
+        run: ./bin/build.sh
+
+      - name: Run example 03
+        run: |
+          docker run --rm \
+            --env GPG_PRIVATE_KEY="${{ secrets.GPG_PRIVATE_KEY }}" \
+            --env PASSPHRASE="${{ secrets.PASSPHRASE }}" \
+            --env MODE="workflow" \
+            --env REPO_DIR="/app" \
+            --volume "$(pwd):/app" \
+            pygithub src/03_sign_commit_using_the_gitpython_package.py

.github/workflows/example-04.yml

@@ -1,10 +1,8 @@
 name: Test workflow for example 04
 
 on:
-  schedule:
-    - cron:  '0 0 * * *'
   push:
-    branches: [ main ]
+    branches: [ main, issue-* ]
 
 jobs:
   import:
@@ -15,10 +13,9 @@ jobs:
       - name: Build docker image
         run: ./bin/build.sh
 
-      - name: Run example
+      - name: Run example 04
         run: |
           docker run --rm \
             --env INPUT_REPO_TOKEN=${{ secrets.GITHUB_TOKEN }} \
             --env INPUT_BRANCH=main \
-            pygithub \
-            python 04_sign_commit_with_multiple_files_using_github_api.py
+            pygithub src/04_sign_commit_with_multiple_files_using_github_api.py

.github/workflows/example-05.yml

@@ -0,0 +1,20 @@
+name: Test workflow for example 05
+
+on:
+  push:
+    branches: [ main, issue-* ]
+
+jobs:
+  import:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build docker image
+        run: ./bin/build.sh
+
+      - name: Run example 05
+        run: |
+          docker run --rm \
+            --volume $(pwd):/app \
+            pygithub src/05_commit_using_the_gitpython_package_without_signing.py

.gitignore

@@ -1 +1,2 @@
-.env
+.env
+private_key.pgp

Dockerfile

@@ -17,6 +17,9 @@ FROM python:3.9
 WORKDIR /app
 COPY --from=builder /opt/venv /opt/venv
 ENV PATH="/opt/venv/bin:$PATH"
-COPY ./src /app
+ENV GPG_TTY /dev/console
+COPY ./gpg-agent.conf /root/.gnupg/
+COPY ./src /app/src
 RUN rm -rf /app/test
-CMD ["python", "/app/src/main.py"]
+CMD ["src/main.py"]
+ENTRYPOINT ["python"]

README.md

@@ -1,13 +1,14 @@
-[![Test workflow for example 01](https://github.com/josecelano/pygithub/actions/workflows/example-01.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-01.yml) [![Test workflow for example 02](https://github.com/josecelano/pygithub/actions/workflows/example-02.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-02.yml) [![Test workflow for example 04](https://github.com/josecelano/pygithub/actions/workflows/example-04.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-04.yml)
+# Git and GitHub API examples using Python
 
-## Git and GitHub API examples using Python
+[![Example 01](https://github.com/josecelano/pygithub/actions/workflows/example-01.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-01.yml) [![Example 02](https://github.com/josecelano/pygithub/actions/workflows/example-02.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-02.yml) [![Example 03](https://github.com/josecelano/pygithub/actions/workflows/example-03.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-03.yml) [![Example 04](https://github.com/josecelano/pygithub/actions/workflows/example-04.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-04.yml) [![Example 05](https://github.com/josecelano/pygithub/actions/workflows/example-05.yml/badge.svg)](https://github.com/josecelano/pygithub/actions/workflows/example-05.yml)
 
 This repo contains some Python examples on using git and GitHub API.
 
 ## Articles
 
 1. [Sign automatic commits in GitHub Actions](./docs/how_to_sign_automatic_commits_in_github_actions.md)
 2. [How to create a single commit with multiple files using GitHub API](./docs/how_to_create_a_single_commit_with_multiple_files_using_github_api.md)
+3. [How to sign commits using the GitPython package](./docs/how_to_sign_commits_using_the_gitpython_package.md)
 
 ## Build and run
 
@@ -27,6 +28,7 @@ Run examples:
 
 ```shell
 ./bin/run-01.sh
+./bin/run-03.sh
 ./bin/run-04.sh
 ./bin/run-main.sh
 ```

bin/run-01.sh

@@ -3,4 +3,4 @@
 docker run --rm -it \
   --env-file .env \
   --volume $(pwd):/app \
-  pygithub python src/01_sign_commit_using_github_api.py
+  pygithub src/01_sign_commit_using_github_api.py

bin/run-03.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+docker run --rm -it \
+  --env-file .env \
+  --env MODE=test \
+  --env REPO_DIR=/app \
+  --volume "$(pwd):/app" \
+  pygithub src/03_sign_commit_using_the_gitpython_package.py

bin/run-04.sh

@@ -4,4 +4,4 @@ docker run --rm -it \
   --env-file .env \
   --env INPUT_BRANCH=main \
   --volume $(pwd):/app \
-  pygithub python src/04_sign_commit_with_multiple_files_using_github_api.py
+  pygithub src/04_sign_commit_with_multiple_files_using_github_api.py

bin/run-05.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+docker run --rm -it \
+  --volume $(pwd):/app \
+  pygithub src/05_commit_using_the_gitpython_package_without_signing.py

bin/run-bash.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+docker run --rm -it \
+  --env-file .env \
+  --volume $(pwd):/app \
+  --entrypoint=/bin/bash \
+  pygithub

data/example-02/latest_datetime.txt

@@ -1 +1 @@
-Mon Nov 29 11:10:14 UTC 2021
+Mon Nov 29 11:27:22 UTC 2021

docs/how_to_create_a_single_commit_with_multiple_files_using_github_api.md

@@ -85,7 +85,7 @@ blob1 = remote_repo.create_git_blob(file_to_update_01_content, "utf-8")
 
 We are using a [Python package](https://github.com/PyGithub/PyGithub) which is a wrapper for the GitHub REST API.
 
-The only way to get the data is by using its SHA and we do not have the filename store anywhere yet. The way git stores the filename is by using another object in the database: the `tree`. The simplest `tree` object only contains a reference to one `blob` object. The `tree` is like a directory with the list of files where the contents of the files are the `blob` objects. We need to create a dir (`tree`) also for only one file because Git will add the file metadata there. The same object is used for one an multiple files. The `tree` can also contains another `tree`.
+The only way to get the data is by using its SHA and we do not have the filename store anywhere yet. The way git stores the filename is by using another object in the database: the `tree`. The simplest `tree` object only contains a reference to one `blob` object. The `tree` is like a directory with the list of files where the contents of the files are the `blob` objects. We need to create a dir (`tree`) also for only one file because Git will add the file metadata there. The same object is used for one an multiple files. The `tree` can also contain another `tree`.
 
 In order to create the `tree`, we need to take the state of the staging area. You first have to set up an index by staging some files with these commands: