oliverdavies.uk/content/node.0f64feba-0a96-41e4-b8e3-10358e4c86c6.yml

104 lines
4.1 KiB
YAML

uuid:
- value: 0f64feba-0a96-41e4-b8e3-10358e4c86c6
langcode:
- value: en
type:
- target_id: daily_email
target_type: node_type
target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
revision_timestamp:
- value: '2025-05-11T09:00:12+00:00'
revision_uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
revision_log: { }
status:
- value: true
uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
title:
- value: 'Referencing other commits in commit messages'
created:
- value: '2024-05-20T00:00:00+00:00'
changed:
- value: '2025-05-11T09:00:12+00:00'
promote:
- value: false
sticky:
- value: false
default_langcode:
- value: true
revision_translation_affected:
- value: true
path:
- alias: /daily/2024/05/20/referencing-other-commits-in-commit-messages
langcode: en
body:
- value: |
<p>Last week, I asked <a href="/daily/2024/05/15/should-you-include-issue-ids-in-your-commit-messages">whether you should include issue IDs in commit messages</a>.</p>
<p>Another thing I like to reference in a commit message is the commit ID (or SHA) of a related commit.</p>
<p>For example, when I run <code>git log</code> in my website repository, I see commits like this:</p>
<pre><code class="plain">commit 0c91825c16217d0fe7eff4ea100a67550051c4a9
Author: Oliver Davies &lt;oliver@oliverdavies.dev&gt;
Date: Sat May 11 15:32:07 2024 +0200
Create a cached talk counter
Create a cached version of the talk counter service that returns a
cached result of the talk count for that day.
This uses the Decorator design pattern to decorate the existing
`TalkCounter` service and works as they both implement the same
`TalkCounterInterface`.
</code></pre>
<p>The sha for this commit is <code>0c91825c16217d0fe7eff4ea100a67550051c4a9</code>.</p>
<p>If I was to make another commit that was related to this one, I can include this commit sha in my new commit message.</p>
<p>I also don't need to include the entire thing - only enough for it to be unique (usually five or six characters).</p>
<p>Once pushed, the commit IDs should never change, so this will be a permanent reference to the first commit.</p>
<p>Helpfully, websites like GitHub, GitLab and Bitbucket will identify it as a commit sha and make it clickable so you can easily navigate to the referenced commit.</p>
format: full_html
processed: |
<p>Last week, I asked <a href="/daily/2024/05/15/should-you-include-issue-ids-in-your-commit-messages">whether you should include issue IDs in commit messages</a>.</p>
<p>Another thing I like to reference in a commit message is the commit ID (or SHA) of a related commit.</p>
<p>For example, when I run <code>git log</code> in my website repository, I see commits like this:</p>
<pre><code class="plain">commit 0c91825c16217d0fe7eff4ea100a67550051c4a9
Author: Oliver Davies &lt;oliver@oliverdavies.dev&gt;
Date: Sat May 11 15:32:07 2024 +0200
Create a cached talk counter
Create a cached version of the talk counter service that returns a
cached result of the talk count for that day.
This uses the Decorator design pattern to decorate the existing
`TalkCounter` service and works as they both implement the same
`TalkCounterInterface`.
</code></pre>
<p>The sha for this commit is <code>0c91825c16217d0fe7eff4ea100a67550051c4a9</code>.</p>
<p>If I was to make another commit that was related to this one, I can include this commit sha in my new commit message.</p>
<p>I also don't need to include the entire thing - only enough for it to be unique (usually five or six characters).</p>
<p>Once pushed, the commit IDs should never change, so this will be a permanent reference to the first commit.</p>
<p>Helpfully, websites like GitHub, GitLab and Bitbucket will identify it as a commit sha and make it clickable so you can easily navigate to the referenced commit.</p>
summary: null
field_daily_email_cta: { }