Allow mainline branch to be defined programmatically.

rcsb · Jul 17, 2023 · e6ea0a8 · e6ea0a8
1 parent c3cdff8
commit e6ea0a8
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 5 deletions.
diff --git a/.github/workflows/workflow-java.yaml b/.github/workflows/workflow-java.yaml
@@ -3,7 +3,17 @@ name: Java Workflow
 
 on:
  workflow_call:
+ inputs:
+ mainline_branch:
+ type: string
+ default: format('refs/heads/{0}', github.event.repository.default_branch)
+ describe: "The mainline branch for the repo. Deployments to the staging and production environments are done only on push to this branch. Defaults to the repo's default branch."
  workflow_dispatch:
+ inputs:
+ mainline_branch:
+ type: string
+ default: format('refs/heads/{0}', github.event.repository.default_branch)
+ describe: "The mainline branch for the repo. Deployments to the staging and production environments are done only on push to this branch. Defaults to the repo's default branch."
 
 jobs:
  # Test projects
@@ -31,15 +41,15 @@ jobs:
  # Staging jobs
  build_jib_staging:
  name: "Build docker image via jib with staging tag"
- if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - build_jib
  uses: ./.github/workflows/run_mvn.yaml
  with:
  script: package jib:build -Djib.to.tags=staging -Djib.target.namespace=rcsb --no-transfer-progress -Dmaven.test.skip=true
  skaffold_deploy_staging:
  name: "Skaffold deploy into staging namespace"
- if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - build_jib_staging
  uses: ./.github/workflows/deploy_skaffold.yaml
@@ -50,14 +60,15 @@ jobs:
  # TODO: Increment version of project through workflow. Add this step once we are ready to retire older workflow files.
  build_docker_production:
  name: "Build docker image via jib with production tag"
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - skaffold_deploy_staging
  uses: ./.github/workflows/run_mvn.yaml
  with:
  script: package jib:build -Djib.to.tags=production -Djib.target.namespace=rcsb --no-transfer-progress -Dmaven.test.skip=true
  skaffold_deploy_production:
  name: Skaffold deploy into production environment"
- if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - build_docker_production
  uses: ./.github/workflows/deploy_skaffold.yaml

diff --git a/.github/workflows/workflow-node.yaml b/.github/workflows/workflow-node.yaml
@@ -3,7 +3,17 @@ name: Node Workflow
 
 on:
  workflow_call:
+ inputs:
+ mainline_branch:
+ type: string
+ default: format('refs/heads/{0}', github.event.repository.default_branch)
+ describe: "The mainline branch for the repo. Deployments to the staging and production environments are done only on push to this branch. Defaults to the repo's default branch."
  workflow_dispatch:
+ inputs:
+ mainline_branch:
+ type: string
+ default: format('refs/heads/{0}', github.event.repository.default_branch)
+ describe: "The mainline branch for the repo. Deployments to the staging and production environments are done only on push to this branch. Defaults to the repo's default branch."
 
 jobs:
  # Build jobs
@@ -43,6 +53,7 @@ jobs:
  # Staging jobs
  build_docker_staging:
  name: "Build docker image with staging tag"
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - test_npm
  - build_docker
@@ -53,7 +64,7 @@ jobs:
  additional_tag: "staging"
  skaffold_deploy_staging:
  name: "Skaffold deploy into staging namespace"
- if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - build_docker_staging
  uses: ./.github/workflows/deploy_skaffold.yaml
@@ -63,6 +74,7 @@ jobs:
  # Production jobs
  build_docker_production:
  name: "Build docker image with production tag"
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - build_docker_staging
  uses: ./.github/workflow/build_docker.yaml
@@ -72,7 +84,7 @@ jobs:
  additional_tag: "production"
  skaffold_deploy_production:
  name: Skaffold deploy into production environment"
- if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+ if: (github.ref == inputs.mainline_branch) && (github.event_name != 'pull_request')
  needs:
  - build_docker_production
  uses: ./.github/workflows/deploy_skaffold.yaml

diff --git a/README.md b/README.md
@@ -26,6 +26,8 @@ jobs:
  run-workflow:
  name: "Run automated workflow"
  uses: rcsb/devops-cicd-github-actions/.github/workflows/workflow-java.yaml@master
+ with:
+ mainline_branch: # The mainline branch for the repo. Deployments to the staging and production environments are done only on push to this branch. Defaults to the repo's default branch.
 ```
 
 # Node Projects
@@ -71,6 +73,8 @@ jobs:
  run-workflow:
  name: "Run automated workflow"
  uses: rcsb/devops-cicd-github-actions/.github/workflows/workflow-node.yaml@master
+ with:
+ mainline_branch: # The mainline branch for the repo. Deployments to the staging and production environments are done only on push to this branch. Defaults to the repo's default branch.
 ```
 
 # Docker Projects