Skip to content

Commit 03f06cd

Browse files
committed
feat: Enhance signing description
1 parent f1444f9 commit 03f06cd

File tree

1 file changed

+9
-5
lines changed
  • src/assets/YAML/default/BuildAndDeployment

1 file changed

+9
-5
lines changed

src/assets/YAML/default/BuildAndDeployment/Build.yaml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,15 @@ Build and Deployment:
159159
Digitally signing artifacts for all steps during the build and especially
160160
docker images, helps to ensure their integrity and authenticity.
161161
description: |
162-
### Github
163-
You need to be authenticated to perform a push to a Github repository. Github doesn't check if the authenticated user and the mail address in the commit corresponds.
164-
To highlight to reviewers who performed a commit, signing is needed.
165-
Be aware that github actions like [semantic-release-action](https://github.com/cycjimmy/semantic-release-action) will not sign commits and will fail. You find an example working configuration to use semantic release action together with [planetscale/ghcommit-action](https://github.com/planetscale/ghcommit-action) in the [workflow folder](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel/blob/master/.github/workflows/main.yml) of DSOMM.
166-
You might want to utilize [Fine-grained personal access tokens](https://github.blog/2022-10-18-introducing-fine-grained-personal-access-tokens-for-github/) from your organization for a specific repository and put the Personal Access Token (PAT) as secret into the project.
162+
### GitHub Authentication and Commit Signing
163+
To perform a push to a GitHub repository, you must be authenticated. It's important to note that GitHub does not verify if the authenticated user's email address matches the one in the commit.
164+
To clearly identify the author of a commit for reviewers, commit signing is recommended.
165+
166+
GitHub actions such as [semantic-release-action](https://github.com/cycjimmy/semantic-release-action) do not automatically sign commits and may encounter issues as a result.
167+
168+
To address this, you can refer to a working configuration example in the [workflow folder](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel/blob/master/.github/workflows/main.yml) of DSOMM, which demonstrates how to use semantic release action in conjunction with [planetscale/ghcommit-action](https://github.com/planetscale/ghcommit-action).
169+
For added security, consider using [Fine-grained personal access tokens](https://github.blog/2022-10-18-introducing-fine-grained-personal-access-tokens-for-github/) provided by your organization for a specific repository. Store the Personal Access Token (PAT) as a secret in your project.
170+
167171
difficultyOfImplementation:
168172
knowledge: 2
169173
time: 2

0 commit comments

Comments
 (0)