oliverdavies.uk/content/node.d047a824-fbb1-40b0-8391-ceba0cc250f5.yml

84 lines
3.6 KiB
YAML

uuid:
- value: d047a824-fbb1-40b0-8391-ceba0cc250f5
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:08+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: 'Using a run file in your CI pipeline'
created:
- value: '2024-07-26T00:00:00+00:00'
changed:
- value: '2025-05-11T09:00:08+00:00'
promote:
- value: false
sticky:
- value: false
default_langcode:
- value: true
revision_translation_affected:
- value: true
path:
- alias: /daily/2024/07/26/using-a-run-file-in-your-ci-pipeline
langcode: en
body:
- value: |
<p><a href="/daily/2022/08/15/using-run-file-simplify-project-tasks">One of my earliest daily emails was about <code>run</code> files</a> - files that contain Bash functions that combine or simplify project-specific tasks.</p>
<p>In Drupal projects, these could be to execute Composer or Drush commands, connect to the database, or run automated tests.</p>
<p>For my CI pipelines, I like to use a function called <code>ci:test</code> that contains all the commands to run in the pipeline.</p>
<p>This keeps the pipeline configuration as simple and agnostic as possible.</p>
<p>It also makes it easy for people to read and, because it's a bash file, it will run anywhere without any additional tools.</p>
<p>For an example, <a href="https://github.com/opdavies/docker-example-drupal/blob/d18bf2242fba1291cabf1e16a5badb6fda7ce509/run#L16-L35">see my Drupal Docker example repository</a>.</p>
<h2 id="here%27s-the-thing">Here's the thing</h2>
<p>The main advantage, though, is being able to run the pipeline locally, if you need to.</p>
<p>Maybe you need to debug a failure in the pipeline or you want to test a change to the pipeline locally before pushing it.</p>
<p>By using a command in a <code>run</code> file, doing so is as simple as running that one command.</p>
format: full_html
processed: |
<p><a href="http://default/daily/2022/08/15/using-run-file-simplify-project-tasks">One of my earliest daily emails was about <code>run</code> files</a> - files that contain Bash functions that combine or simplify project-specific tasks.</p>
<p>In Drupal projects, these could be to execute Composer or Drush commands, connect to the database, or run automated tests.</p>
<p>For my CI pipelines, I like to use a function called <code>ci:test</code> that contains all the commands to run in the pipeline.</p>
<p>This keeps the pipeline configuration as simple and agnostic as possible.</p>
<p>It also makes it easy for people to read and, because it's a bash file, it will run anywhere without any additional tools.</p>
<p>For an example, <a href="https://github.com/opdavies/docker-example-drupal/blob/d18bf2242fba1291cabf1e16a5badb6fda7ce509/run#L16-L35">see my Drupal Docker example repository</a>.</p>
<h2 id="here%27s-the-thing">Here's the thing</h2>
<p>The main advantage, though, is being able to run the pipeline locally, if you need to.</p>
<p>Maybe you need to debug a failure in the pipeline or you want to test a change to the pipeline locally before pushing it.</p>
<p>By using a command in a <code>run</code> file, doing so is as simple as running that one command.</p>
summary: null
field_daily_email_cta: { }