feat!: move DECAF_ROOT_WORKING_DIRECTORY env var to input script data - #204
Draft
levibostian wants to merge 1 commit into
Draft
feat!: move DECAF_ROOT_WORKING_DIRECTORY env var to input script data#204levibostian wants to merge 1 commit into
levibostian wants to merge 1 commit into
Conversation
As I was looking through the Decaf SDK code, I was trying to find all of the code that the SDK has to keep in sync with Decaf. If DCF changes something, then we would break the SDK. The goal is that the SDK breaks as little as possible and is always backwards compatible with DCF. I then looked at all environment variables that they have to keep in sync, and I found this one. I think that actually it was the wrong move to make this an environment variable and instead it should be a part of the input data because the entire design pattern of Decaf is that we pass everything to you that you need with JSON, and then you give us back everything we need with JSON. So I feel like this also needs to follow that pattern.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
As I was looking through the Decaf SDK code, I was trying to find all of the code that the SDK has to keep in sync with Decaf. If DCF changes something, then we would break the SDK. The goal is that the SDK breaks as little as possible and is always backwards compatible with DCF.
I then looked at all environment variables that they have to keep in sync, and I found this one. I think that actually it was the wrong move to make this an environment variable and instead it should be a part of the input data because the entire design pattern of Decaf is that we pass everything to you that you need with JSON, and then you give us back everything we need with JSON.
So I feel like this also needs to follow that pattern.
Related GitHub Issues
Problem
Solution
Testing
The automated test suite has been updated with essentially a refactor where we're swapping an environment variable for input data. Along with that, we are using this pull request to ensure that everything works as expected. Some of the decaf scripts will need to be changed because of this, so this pull request will be a good test for that.
Notes for reviewers
Currently in draft until I edit my decaf scripts to confirm this is an OK change to make.