Use staging buckets by default #57
Merged
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
allyhawkins
approved these changes
Jun 4, 2024
| The run modes available are: | ||
|
|
||
| - `test`: runs only a simple test workflow to check configuration | ||
| - `simulated`: runs the workflow using simulated data | ||
| - `scpca`: runs the workflow using the current ScPCA data release | ||
| - `full`: simulates data based on the current ScPCA data release, then runs the workflow using the simulated data and current ScPCA data release (this is same as the behavior of the automatic release workflow) | ||
|
|
||
| By default, the output mode will be set to `staging`, so all outputs will be saved to S3 buckets that are not shared with users and can not overwrite current production data. | ||
| With the `prod` output mode, results will be accessible visible to users. |
There was a problem hiding this comment.
Suggested change
| With the `prod` output mode, results will be accessible visible to users. | |
| With the `prod` output mode, results will be accessible to users. |
There was a problem hiding this comment.
Maybe add a note that prod should only be used for releases?
There was a problem hiding this comment.
How's this?
Suggested change
| With the `prod` output mode, results will be accessible visible to users. | |
| With the `prod` output mode, results will be accessible to users. | |
| `prod` output mode should used for versioned releases of the workflow, and when running on new ScPCA data releases. |
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.
Closes #44
Here I am adding use of the staging buckets that were created in https://github.com/AlexsLemonade/OpenScPCA-infra/pull/33 to the workflow.
The idea is that most runs initiated through workflow triggers will use the staging buckets, with the production buckets reserved for tagged releases. I am not currently enforcing that: setting a run to
prodis still possible from the GHA, though I wonder if I should instead make it only run on version tags.I moved the setting of the simulated data bucket out to a more global param to make it more visible and consistent, but note that I left Docker image definitions with the code that they are used for.
I also updated the readme to cover these options and to describe which buckets are being used for the action outputs.