Create a mechanism to fail the CD when required environment variables are missing | issue#257 #274
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Saitharun279
changed the title
environment-variables.txt
Outdated
There was a problem hiding this comment.
do we really need this file, .env file is not enough
There was a problem hiding this comment.
Initially i tried by hardcoding the environment variables in the bash script along with "if" conditional blocks for each env var. To use while loop I stored them in a file, bash script iterates through each env var and checks if they are set.
.env file is used for local setup as per guidelines in contributing.MD file link.
So I used a different file.
We can add a .env file as well, but that will be confusing during local setup.
There was a problem hiding this comment.
Removed that file , instead added one env var to store all the actual env var names
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Date: 13-10-2024
Developer Name: Saitharun Burra
Issue Ticket Number
Description
Added a job called
Environment-Variables-Checkto the Register and deploy Slash Commands Github Action. This jobs runs first in sequence to check whether the required environment variables have been configured or not. Fails the workflow incase any of the required environment variables are not configured.Documentation Updated?
Under Feature Flag
Database Changes
Breaking Changes
Development Tested?
Screenshots
Attached 2 videos 1st one contains happy path test for environment variable check when all the required env var are set. This was tested in staging environment with all the required environment variables in the file configured. And the other one displays error logs when the required env var are not set. This was tested in production environment with none of the environment variables set.
Note: All the tests have been conducted in the forked repo.
Screen.Recording.2024-10-13.at.11.40.32.PM.mov
Screen.Recording.2024-10-13.at.11.41.15.PM.mov
Test Coverage
Screenshot 1
Additional Notes
design doc
https://docs.google.com/document/d/1qwCHNbsCONjSTtOkF6wqNdJ4kwkgI11gwbQ_xdPK_m0/edit?pli=1&tab=t.0