#1917 - Release workflows #1986

andrewsignori-aot · 2023-06-02T02:43:06Z

Reorganized the workflows names with the intention to have them grouped in the UI as Env Setup, Release, and Repo Checks.
- Env Setup - Build and Deploy Forms Server
- Env Setup - Deploy SIMS Secrets to Openshift
- Release - Build All
- Release - Create Branch
- Release - Deploy Camunda Resources
- Release - Deploy Form.io resources
- Repo Checks - Tests
The "build" section from .github/workflows/release-build-all.yml was not changed. The apps are building as they were before.
The semantic version to add the build using the "+" is not valid to be used as the Openshift image name and the "-" was used instead, so, instead of v1.0.0+123 we will have v1.0.0-123. The idea is still to keep a clear separation between the semantic version part and the build part. Thoughts?
Created the Release - Create Branch to start new release/hotfix cycles, as shown in the below image.
Changed the build process to accommodate also the below image flow.

ann-aot · 2023-06-05T21:25:33Z

The semantic version to add the build using the "+" is not valid to be used as the Openshift image name and the "-" was used instead, so, instead of v1.0.0+123 we will have v1.0.0-123. The idea is still to keep a clear separation between the semantic version part and the build part. Thoughts?

I am good with - approach 👍

ann-aot · 2023-06-05T21:52:13Z

.github/workflows/release-build-all.yml

+
+  # Deploy all applications to DEV when there is a pull request on the main branch.
+  # If DEV is used to deploy a release or hotfix branch the automatic deploy can be stopped using the env variable because there
+  # is a potencial to main/relase/hotfix branches have differences (for instance o DB) that would not be backward compatible.


(for instance o DB) ?

"o" is the equivalent of "the" in Portuguese 😄

ann-aot · 2023-06-05T21:54:18Z

.github/workflows/release-build-all.yml

+  # If DEV is used to deploy a release or hotfix branch the automatic deploy can be stopped using the env variable because there
+  # is a potencial to main/relase/hotfix branches have differences (for instance o DB) that would not be backward compatible.
+  deployAll:
+    if: github.event_name == 'pull_request' && vars.ALLOW_AUTOMATIC_MAIN_BRANCH_DEPLOY_TO_DEV == 'true' && github.ref_name == 'main'


mm, does github.ref_name == 'main' logic make sure that the PR on main branch?

main will be the branch name that triggered the workflow, so I believe that it is a safe way.

ya...so, according to the comment, how does the workflow know that the PR was on the main branch not on the release or hotfix branch? is it with ALLOW_AUTOMATIC_MAIN_BRANCH_DEPLOY_TO_DEV? Maybe I am missing something

Yes @ann-aot you are right, the github.ref_name == 'main' logic make sure that the deployAll job (deployment) will run only when the workflow is triggered from main branch.

@ann-aot my comment had the link to the documentation on Github that explains the github.ref_name.
To be clear, this is the link: https://docs.github.com/en/actions/learn-github-actions/contexts
This is the documentation.

Please let me know if there is any further question.

Got it. Thanks for explaining @guru-aot and @andrewsignori-aot

ann-aot · 2023-06-05T22:00:09Z

.github/workflows/release-create-branch.yml

+      versionName:
+        description: "Version name (must follow e.g. v1.0.0)"
+        required: true
+        default: "v0.0.0"


do we need a default value here?

Nope, but I thought that it would be good to lead the user to exactly what we expected.

ann-aot

LGTM. some minor comments added

dheepak-aot · 2023-06-05T22:06:36Z

.github/workflows/release-build-all.yml

+  workflow_dispatch:
+
+env:
+  BUILD_NAMESPACE: 0c27fb-tools


Not a part of this PR. Namespace could be a non-secret env from github?

I liked the idea, I will do it in an upcoming PR.

dheepak-aot · 2023-06-05T22:12:58Z

.github/workflows/release-build-all.yml

+          ref: ${{ needs.createTag.outputs.newTag }}
+      - name: Log in to OpenShift
+        run: |
+          oc login --token=${{ secrets.SA_TOKEN }} --server=https://api.silver.devops.gov.bc.ca:6443


openshift url : same as https://github.com/bcgov/SIMS/pull/1986/files#r1218644118

I liked the idea, I will do it in an upcoming PR.

.github/workflows/release-build-all.yml

dheepak-aot · 2023-06-05T22:19:50Z

.github/workflows/release-build-all.yml

+  # If DEV is used to deploy a release or hotfix branch the automatic deploy can be stopped using the env variable because there
+  # is a potencial to main/relase/hotfix branches have differences (for instance o DB) that would not be backward compatible.
+  deployAll:
+    if: github.event_name == 'pull_request' && vars.ALLOW_AUTOMATIC_MAIN_BRANCH_DEPLOY_TO_DEV == 'true' && github.ref_name == 'main'


vars.ALLOW_AUTOMATIC_MAIN_BRANCH_DEPLOY_TO_DEV == 'true' 👍

.github/workflows/release-create-branch.yml

dheepak-aot · 2023-06-05T22:43:17Z

.github/workflows/release-deploy-all.yml

        required: true
        type: string
+    secrets:
+      SA_TOKEN:


This ensures that the required secrets and in place before the workflow starts right? I meant if any of these secrets are missing then it will fail upfront?

That is the idea. It also does not work if they are not present. I will be able to test it once it is merged into the main.

dheepak-aot · 2023-06-05T22:45:04Z

Great work and thanks for walk through. Just a few minor comments.

.github/workflows/release-build-all.yml

sh16011993 · 2023-06-05T23:42:37Z

Thank You for the walkthrough. LGTM 👍

sonarqubecloud · 2023-06-06T00:16:20Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

github-actions · 2023-06-06T00:17:16Z

Backend Unit Tests Coverage Report

Totals
Statements:	17.91% ( 2091 / 11672 )
Methods:	8.23% ( 123 / 1494 )
Lines:	20.69% ( 1832 / 8853 )
Branches:	10.26% ( 136 / 1325 )

github-actions · 2023-06-06T00:17:53Z

E2E Workflow Workers Coverage Report

Totals
Statements:	49.81% ( 267 / 536 )
Methods:	41.56% ( 32 / 77 )
Lines:	55.33% ( 218 / 394 )
Branches:	26.15% ( 17 / 65 )

github-actions · 2023-06-06T00:19:04Z

E2E Queue Consumers Coverage Report

Totals
Statements:	69.4% ( 390 / 562 )
Methods:	59.15% ( 42 / 71 )
Lines:	71.52% ( 344 / 481 )
Branches:	40% ( 4 / 10 )

github-actions · 2023-06-06T00:25:39Z

E2E SIMS API Coverage Report

Totals
Statements:	43.53% ( 3040 / 6984 )
Methods:	37.65% ( 340 / 903 )
Lines:	48.6% ( 2533 / 5212 )
Branches:	19.22% ( 167 / 869 )

sh16011993

LGTM 👍 Thank You for the code walkthrough

guru-aot · 2023-06-06T16:22:16Z

.github/workflows/env-setup-build-deploy-forms-server.yml

@@ -1,4 +1,4 @@
-name: Build and Deploy Formio Server.
+name: Env Setup - Build and Deploy Forms Server


guru-aot · 2023-06-06T16:22:24Z

.github/workflows/env-setup-deploy-secrets.yml

@@ -1,4 +1,4 @@
-name: Deploy SIMS secrets to Openshift
+name: Env Setup - Deploy SIMS Secrets to Openshift


guru-aot · 2023-06-06T16:46:02Z

.github/workflows/release-build-all.yml

@@ -0,0 +1,199 @@
+name: Release - Build All


As this has the deployAll to main branch, can we please change the name to Build All / and Deploy to Dev. Also if possible please change the deployAll name to deployDev.

I see the point, but the intention of the script is to build, the "deploy" part is just to keep to the current behavior of building and deploying for the main branch to ensure that it is "deployable". As we talked I would prefer to keep the name as it is for now.

guru-aot · 2023-06-06T16:47:32Z

.github/workflows/release-build-all.yml

+  # Deploy all applications to DEV when there is a pull request on the main branch.
+  # If DEV is used to deploy a release or hotfix branch the automatic deploy can be stopped using the env variable because there
+  # is a Potential to main/relase/hotfix branches have differences (for instance the DB) that would not be backward compatible.
+  deployAll:


https://github.com/bcgov/SIMS/pull/1986/files#r1219983294, Please change the job name to deployDev

guru-aot · 2023-06-06T16:54:35Z

.github/workflows/release-deploy-all.yml

      deployFormioDefinitions:
        required: true
        type: string
+    secrets:


guru-aot · 2023-06-06T17:05:03Z

.github/workflows/release-build-all.yml

+    name: Deploy All to DEV
+    needs:
+      [
+        createTag,


please remove createTag as its a need in build-db-migrations

I tried to remove and then I remember that we need it to be able to consume the tag name.
gitRef: ${{ needs.createTag.outputs.newTag }}

nice catch 👍

guru-aot

Nice work @andrewsignori-aot, please have a look on the comments.

ann-aot

LGTM 👍
Thanks for the walkthrough

dheepak-aot

LGTM. Thanks for making the changes.

andrepestana-aot

Looks good!

guru-aot

LGTM, nice work @andrewsignori-aot

andrewsignori-aot added 3 commits June 1, 2023 16:41

Create release branch workflow

bf87024

New build workflow

d5e3c88

Change build separator

96deb3b

andrewsignori-aot self-assigned this Jun 2, 2023

andrewsignori-aot added the Devops Devops label Jun 2, 2023

andrewsignori-aot added 13 commits June 1, 2023 19:53

Renaming workflow files

931130e

Changed build separator

350e148

Fix reusable workflows references

698afe4

Testing Deploy All

907071c

Test release-deploy call

756062f

Updated build deploy dev

db28b95

Renamed target branch

40d1676

Build RC

93c42c7

Fix vars

bc3a178

Deploy All conditions

17aad7c

Pass secrets to reusable workflows

734a66f

Final release workflow

000911e

Fix e.g. main-456

33eded4

andrewsignori-aot marked this pull request as ready for review June 5, 2023 18:54

andrewsignori-aot requested review from JasonCTang, andrepestana-aot, ann-aot, dheepak-aot, guru-aot and sh16011993 June 5, 2023 18:55

ann-aot reviewed Jun 5, 2023

View reviewed changes

dheepak-aot reviewed Jun 5, 2023

View reviewed changes

.github/workflows/release-build-all.yml Outdated Show resolved Hide resolved

dheepak-aot reviewed Jun 5, 2023

View reviewed changes

.github/workflows/release-create-branch.yml Outdated Show resolved Hide resolved

dheepak-aot reviewed Jun 5, 2023

View reviewed changes

.github/workflows/release-create-branch.yml Show resolved Hide resolved

dheepak-aot reviewed Jun 5, 2023

View reviewed changes

sh16011993 reviewed Jun 5, 2023

View reviewed changes

.github/workflows/release-build-all.yml Show resolved Hide resolved

PR review comments

aa220b1

sh16011993 approved these changes Jun 6, 2023

View reviewed changes

guru-aot reviewed Jun 6, 2023

View reviewed changes

.github/workflows/release-deploy-all.yml

deployFormioDefinitions:

required: true

type: string

secrets:

Copy link

Contributor

guru-aot Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

guru-aot reviewed Jun 6, 2023

View reviewed changes

ann-aot approved these changes Jun 6, 2023

View reviewed changes

dheepak-aot approved these changes Jun 6, 2023

View reviewed changes

andrepestana-aot approved these changes Jun 6, 2023

View reviewed changes

guru-aot approved these changes Jun 6, 2023

View reviewed changes

andrewsignori-aot merged commit 756a430 into main Jun 6, 2023

andrewsignori-aot deleted the release-workflows-1917 branch June 7, 2023 00:00

		@@ -1,4 +1,4 @@
		name: Build and Deploy Formio Server.
		name: Env Setup - Build and Deploy Forms Server

		@@ -1,4 +1,4 @@
		name: Deploy SIMS secrets to Openshift
		name: Env Setup - Deploy SIMS Secrets to Openshift

#1917 - Release workflows #1986

#1917 - Release workflows #1986

Uh oh!

Conversation

andrewsignori-aot commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ann-aot commented Jun 5, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Jun 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Jun 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ann-aot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Jun 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dheepak-aot commented Jun 5, 2023

Uh oh!

Uh oh!

sh16011993 commented Jun 5, 2023

Uh oh!

sonarqubecloud bot commented Jun 6, 2023

Uh oh!

github-actions bot commented Jun 6, 2023

Backend Unit Tests Coverage Report

Uh oh!

github-actions bot commented Jun 6, 2023

E2E Workflow Workers Coverage Report

Uh oh!

github-actions bot commented Jun 6, 2023

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Jun 6, 2023

E2E SIMS API Coverage Report

Uh oh!

sh16011993 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

andrewsignori-aot commented Jun 2, 2023 •

edited

Loading

andrewsignori-aot Jun 5, 2023 •

edited

Loading

andrewsignori-aot Jun 6, 2023 •

edited

Loading

andrewsignori-aot Jun 6, 2023 •

edited

Loading

guru-aot Jun 6, 2023 •

edited

Loading