Skip to content

Commit

Permalink
use a mermaid diagram of ultimate coolness
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneknapp committed Oct 25, 2024
1 parent fa32240 commit 19bd87c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
1 change: 0 additions & 1 deletion docs/admins/ci-cd-workflow.svg

This file was deleted.

25 changes: 24 additions & 1 deletion docs/admins/cicd-github-actions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,30 @@ a list of what's to be deployed.
That list is iterated over, and [hubploy](https://github.com/berkeley-dsep-infra/hubploy)
is used to deploy only the flagged hubs.

![CI/CD workflow for single-user server images](ci-cd-workflow.svg)

```{mermaid}
%% State diagram documentation at
%% https://mermaid.js.org/syntax/stateDiagram.html
stateDiagram-v2
image_repo: github.com/berkeley-dsep-infra/hubname-user-image
forked_repo: github.com/github username/hubname-user-image
image_test_build: Image is built and tested
image_push_build: Image is built and pushed to registry
pr_created: A pull request is automatically<br/>created in the Datahub repo
deploy_to_staging: Hub is deployed to staging
contributor_tests: The contributor logs into the<br/>staging hub and tests the image.
deploy_to_prod: Hub is deployed to prod
image_repo --> forked_repo: Contributor forks the image repo.
forked_repo --> image_repo: Contributor creates a PR.
image_repo --> image_test_build
image_test_build --> image_push_build: Test build passes and Datahub staff merge pull request
image_push_build --> pr_created
pr_created --> deploy_to_staging: Datahub staff review and merge to staging
deploy_to_staging --> contributor_tests
contributor_tests --> deploy_to_prod: Datahub staff create a PR to merge to prod
```

#### Support and node-placeholder charts

Expand Down

0 comments on commit 19bd87c

Please sign in to comment.