From 38a73d177ef196234d439c357a277e57704040dd Mon Sep 17 00:00:00 2001
From: Jonathan Pezzino
 <4056124+softwareengineerprogrammer@users.noreply.github.com>
Date: Sun, 5 Nov 2023 11:38:53 -0800
Subject: [PATCH] Document deploy_docs condition

Document deploy_docs condition in github-actions.yml to test https://github.com/softwareengineerprogrammer/python-geophires-x-nrel/commit/27b7d8b851d686f8f26ced28bcb98f5978fdb04d (https://github.com/NREL/python-geophires-x/issues/31)
---
 .github/workflows/github-actions.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml
index 1166b8dc..23850ecc 100644
--- a/.github/workflows/github-actions.yml
+++ b/.github/workflows/github-actions.yml
@@ -130,7 +130,7 @@ jobs:
 
   deploy_docs:
     name: Deploy docs to GitHub Pages
-    if: github.ref == 'refs/heads/main'
+    if: github.ref == 'refs/heads/main' # Prevent from running on PRs, tags
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}