From 11706e4b126b264bfa418004541721bbb7e502e6 Mon Sep 17 00:00:00 2001 From: Nicolas Busseneau Date: Mon, 19 Jul 2021 11:41:59 +0200 Subject: [PATCH] workflows: add warning/explanation for testing workflow changes This should help clarify that any changes to workflow files or workflow scripts should be tested from a PR using the `pull_request` trigger before merging. Signed-off-by: Nicolas Busseneau --- .github/workflows/aks.yaml | 14 ++++++++++++++ .github/workflows/eks-tunnel.yaml | 14 ++++++++++++++ .github/workflows/eks.yaml | 14 ++++++++++++++ .github/workflows/externalworkloads.yaml | 14 ++++++++++++++ .github/workflows/gke.yaml | 14 ++++++++++++++ .github/workflows/multicluster.yaml | 14 ++++++++++++++ 6 files changed, 84 insertions(+) diff --git a/.github/workflows/aks.yaml b/.github/workflows/aks.yaml index 5ce46578ef..31e6788c5f 100644 --- a/.github/workflows/aks.yaml +++ b/.github/workflows/aks.yaml @@ -2,6 +2,20 @@ name: AKS # Any change in triggers needs to be reflected in the concurrency group. on: + ### FOR TESTING PURPOSES + # This workflow runs in the context of `master`, and ignores changes to + # workflow files in PRs. For testing changes to this workflow from a PR: + # - Make sure the PR uses a branch from the base repository (requires write + # privileges). It will not work with a branch from a fork (missing secrets). + # - Uncomment the `pull_request` event below, commit separately with a `DO + # NOT MERGE` message, and push to the PR. As long as the commit is present, + # any push to the PR will trigger this workflow. + # - Don't forget to remove the `DO NOT MERGE` commit once satisfied. The run + # will disappear from the PR checks: please provide a direct link to the + # successful workflow run (can be found from Actions tab) in a comment. + # + # pull_request: {} + ### pull_request: {} # Run every 6 hours schedule: diff --git a/.github/workflows/eks-tunnel.yaml b/.github/workflows/eks-tunnel.yaml index 0462766913..02b6305302 100644 --- a/.github/workflows/eks-tunnel.yaml +++ b/.github/workflows/eks-tunnel.yaml @@ -2,6 +2,20 @@ name: EKS (tunnel) # Any change in triggers needs to be reflected in the concurrency group. on: + ### FOR TESTING PURPOSES + # This workflow runs in the context of `master`, and ignores changes to + # workflow files in PRs. For testing changes to this workflow from a PR: + # - Make sure the PR uses a branch from the base repository (requires write + # privileges). It will not work with a branch from a fork (missing secrets). + # - Uncomment the `pull_request` event below, commit separately with a `DO + # NOT MERGE` message, and push to the PR. As long as the commit is present, + # any push to the PR will trigger this workflow. + # - Don't forget to remove the `DO NOT MERGE` commit once satisfied. The run + # will disappear from the PR checks: please provide a direct link to the + # successful workflow run (can be found from Actions tab) in a comment. + # + # pull_request: {} + ### pull_request_target: {} # Run every 6 hours schedule: diff --git a/.github/workflows/eks.yaml b/.github/workflows/eks.yaml index 6697e313b6..17c246d47c 100644 --- a/.github/workflows/eks.yaml +++ b/.github/workflows/eks.yaml @@ -2,6 +2,20 @@ name: EKS (ENI) # Any change in triggers needs to be reflected in the concurrency group. on: + ### FOR TESTING PURPOSES + # This workflow runs in the context of `master`, and ignores changes to + # workflow files in PRs. For testing changes to this workflow from a PR: + # - Make sure the PR uses a branch from the base repository (requires write + # privileges). It will not work with a branch from a fork (missing secrets). + # - Uncomment the `pull_request` event below, commit separately with a `DO + # NOT MERGE` message, and push to the PR. As long as the commit is present, + # any push to the PR will trigger this workflow. + # - Don't forget to remove the `DO NOT MERGE` commit once satisfied. The run + # will disappear from the PR checks: please provide a direct link to the + # successful workflow run (can be found from Actions tab) in a comment. + # + # pull_request: {} + ### pull_request_target: {} # Run every 6 hours schedule: diff --git a/.github/workflows/externalworkloads.yaml b/.github/workflows/externalworkloads.yaml index 198d1ed1e7..bba055a516 100644 --- a/.github/workflows/externalworkloads.yaml +++ b/.github/workflows/externalworkloads.yaml @@ -2,6 +2,20 @@ name: External Workloads # Any change in triggers needs to be reflected in the concurrency group. on: + ### FOR TESTING PURPOSES + # This workflow runs in the context of `master`, and ignores changes to + # workflow files in PRs. For testing changes to this workflow from a PR: + # - Make sure the PR uses a branch from the base repository (requires write + # privileges). It will not work with a branch from a fork (missing secrets). + # - Uncomment the `pull_request` event below, commit separately with a `DO + # NOT MERGE` message, and push to the PR. As long as the commit is present, + # any push to the PR will trigger this workflow. + # - Don't forget to remove the `DO NOT MERGE` commit once satisfied. The run + # will disappear from the PR checks: please provide a direct link to the + # successful workflow run (can be found from Actions tab) in a comment. + # + # pull_request: {} + ### pull_request_target: {} # Run every 6 hours schedule: diff --git a/.github/workflows/gke.yaml b/.github/workflows/gke.yaml index 2ead4c117a..b4c441f9af 100644 --- a/.github/workflows/gke.yaml +++ b/.github/workflows/gke.yaml @@ -2,6 +2,20 @@ name: GKE # Any change in triggers needs to be reflected in the concurrency group. on: + ### FOR TESTING PURPOSES + # This workflow runs in the context of `master`, and ignores changes to + # workflow files in PRs. For testing changes to this workflow from a PR: + # - Make sure the PR uses a branch from the base repository (requires write + # privileges). It will not work with a branch from a fork (missing secrets). + # - Uncomment the `pull_request` event below, commit separately with a `DO + # NOT MERGE` message, and push to the PR. As long as the commit is present, + # any push to the PR will trigger this workflow. + # - Don't forget to remove the `DO NOT MERGE` commit once satisfied. The run + # will disappear from the PR checks: please provide a direct link to the + # successful workflow run (can be found from Actions tab) in a comment. + # + # pull_request: {} + ### pull_request_target: {} # Run every 6 hours schedule: diff --git a/.github/workflows/multicluster.yaml b/.github/workflows/multicluster.yaml index bd2ac02c59..9d079f5b0c 100644 --- a/.github/workflows/multicluster.yaml +++ b/.github/workflows/multicluster.yaml @@ -2,6 +2,20 @@ name: Multicluster # Any change in triggers needs to be reflected in the concurrency group. on: + ### FOR TESTING PURPOSES + # This workflow runs in the context of `master`, and ignores changes to + # workflow files in PRs. For testing changes to this workflow from a PR: + # - Make sure the PR uses a branch from the base repository (requires write + # privileges). It will not work with a branch from a fork (missing secrets). + # - Uncomment the `pull_request` event below, commit separately with a `DO + # NOT MERGE` message, and push to the PR. As long as the commit is present, + # any push to the PR will trigger this workflow. + # - Don't forget to remove the `DO NOT MERGE` commit once satisfied. The run + # will disappear from the PR checks: please provide a direct link to the + # successful workflow run (can be found from Actions tab) in a comment. + # + # pull_request: {} + ### pull_request_target: {} # Run every 6 hours schedule: