Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add preview workflow #1909

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

justinjao
Copy link

What?

Fix #1908

This PR constitutes the work done for the Google Summer of Code project for Justin Jao, as referenced here.

This adds a proposed workflow for automating the deployment of a staging environment upon PR creation to the datahub repo.

In particular:

  • a preview.yml workflow file that triggers the automated deployment of the staging environment with the new studies imported
  • a preview_closed.yml file that automatically tears down the deployed staging environment upon PR closure or merging.
  • the directory and miscellaneous file infrastructure (located within the added preview directory) necessary to support this automated deployment
  • documentation for this proposed workflow, located within the documentation directory

Important Notes:

  • This PR currently must undergo further discussion to determine which account will setup the Okteto infrastructure needed for this workflow to function
  • After this has been determined, the namespace listed in the code will need to be changed accordingly within each of these files
  • Before merging, certain steps, such as adding Okteto secrets, must be undertaken (documented in Preview_Setup.md) before the workflow will be fully functional
  • Currently, not all studies may be imported, as there is a known issue with gene panels IDs not being present in the seeded database. This may be fixed in a future update, but for now, a temporary stopgap has been placed (documented in Preview_Overview.md).
  • For more information about this workflow, please see the produced documentation at Preview_Overview.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Streamline Data Validation Process with Automated Staging Environment
1 participant