From 7f1f53cd7835aba17099b5bce25f81d5efe91524 Mon Sep 17 00:00:00 2001
From: mkolasinski-splunk <mkolasinski@splunk.com>
Date: Wed, 25 Sep 2024 13:23:47 +0200
Subject: [PATCH] fix: publish conditions fix and documentation adjustments

---
 .github/pull_request_template.md                  | 13 +++++++++++++
 .github/workflows/reusable-build-test-release.yml |  5 +++--
 README.md                                         | 14 +++++++++++++-
 3 files changed, 29 insertions(+), 3 deletions(-)
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..7e9aab6d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,13 @@
+### Description
+
+(PR description goes here)
+
+### Checklist
+
+- [ ] `README.md` has been updated or is not required
+- [ ] push trigger tests
+- [ ] manual release test
+- [ ] automated releaes test
+- [ ] pull request trigger tests
+- [ ] schedule trigger tests
+- [ ] workflow errors/warnings reviewed and addressed
diff --git a/.github/workflows/reusable-build-test-release.yml b/.github/workflows/reusable-build-test-release.yml
index be6e3875..aa3c47c0 100644
--- a/.github/workflows/reusable-build-test-release.yml
+++ b/.github/workflows/reusable-build-test-release.yml
@@ -2333,7 +2333,7 @@ jobs:
                 summary-scripted*
 
   pre-publish:
-    if: ${{ !cancelled() && needs.validate-custom-version.result == 'success' }}
+    if: ${{ !cancelled() }}
     # The following line will rename 'pre-publish' to 'pre-publish-not_main_pr' when PR is created towards main branch
     # It is necessary to avoid confusion caused by githubactions considering pre-publish for both push to develop branch
     # and pull_request to main branch events.
@@ -2377,8 +2377,9 @@ jobs:
 
   publish:
     if: |
-      (!cancelled() && needs.pre-publish.result == 'success' && github.event_name != 'pull_request' && github.event_name != 'schedule') ||
+      (!cancelled() && needs.pre-publish.result == 'success' && github.event_name == 'push' && github.event.inputs.custom-version == '') ||
       (!cancelled() && needs.pre-publish.result == 'success' && github.event.inputs.custom-version != '' && needs.validate-custom-version.result == 'success')
+    # First condition for standard release process, second one for manual custom-version release process
     name: ${{ github.event.inputs.custom-version == '' &&  'publish' ||  'publish-custom-version' }}
 
     needs:
diff --git a/README.md b/README.md
index 3a801f20..b7e8bde0 100644
--- a/README.md
+++ b/README.md
@@ -17,13 +17,25 @@ Workflow defines jobs which perform security code scanning, execute different ty
 * If bugfix release is needed:
   * make a change
   * test it
+    * pull-request scenario
+    * push scenario
+    * release scenario (test-addonfactory-repository)
   * create a PR to the `main` branch
   * get all the approvals from the team
   * merge it using "squash commit" option
   * backport the change back to the `develop` branch
   * new version of the workflow is going to be released (v4.17.0 (before) -> v4.17.1 (after)) and it will automatically applied to all the repositories
 
-# Troubleshooting for different workflow stages in GitHub Actions
+# Workflow jobs
+
+## Inputs
+* marker - list of markers used to paralelize modinput tests
+* ui_marker - list of markers used to paralelize ui tests
+* custom-version - version used for release on manual workflow trigger
+* execute-tests-on-push-to-release - enable tests on release branch - default false
+* k8s-enfironment - k8s environment for testing
+* k8s-manifests-branch - k8s-manifests branch for testing
+* scripted-inputs-os-list - list of OSes used for scripted inputs tests
 
 ## General troubleshooting