From 072cfb1b2db8fda903e35b9bd4b699270b56eb3f Mon Sep 17 00:00:00 2001
From: jantoun-scottlogic <jantoun@scottlogic.com>
Date: Wed, 22 May 2024 11:08:36 +0100
Subject: [PATCH] Add documentation about skipping workflows on pushes to a PR
 branch

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 8d79339a..39d0a61b 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,10 @@ Run `ng build` to build the project. The build artifacts will be stored in the `
 
 Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
+## GitHub Actions
+
+The project uses [GitHub Actions](https://docs.github.com/en/actions) to automate certain workflows. One such workflow runs when opening a pull request and pushing changes to the related branch. If you would like to skip running the workflow for a given push to a PR branch there are [various ways](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs) this can be achieved. For example, adding `[skip ci]` to the end of the commit message in the push (e.g. `git commit -m "My message [skip ci]"`) will skip running the workflow for that push.
+
 ## Further help
 
 To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.