Skip to content

Commit

Permalink
docs(ci): updated references to k8s workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
themightychris committed Jan 6, 2024
1 parent d71288c commit 3ccbe31
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .holo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ By projecting this holobranch in GitHub Actions, a tree containing only the code
as well as Kubernetes code from the upstream [cluster-template](https://github.com/JarvusInnovations/cluster-template)
repository is generated.

See [`ci/README.md`](../ci/README.md) for details on the pull request workflow for previewing and deploying Kubernetes changes.
See [`kubernetes/README.md`](../kubernetes/README.md#gitops) for details on the pull request workflow for previewing and deploying Kubernetes changes.
24 changes: 1 addition & 23 deletions ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,4 @@ poetry run invoke release -f channels/test.yaml

## GitOps

In this diagram, arrows represent human actions such as opening and merging PRs and nodes (except for the very first) represent automated actions such as `invoke` deploying to the cluster. Green nodes indicate a deployment while white nodes indicate an automated git action such as branch creation or commenting on a pull request.

```mermaid
flowchart TD
classDef default fill:white, color:black, stroke:black
classDef initial fill:lightblue, color:black
classDef deploy fill:lightgreen, color:black
pr[Push commits to a branch.\nDoes a test environment exist?]
candidates_branch[GitHub Action renders candidates/branch-name]
branch_diff[invoke diff renders on test PR]
branch_invoke[invoke releases to test]
candidates_main[GitHub Action builds images and renders candidates/main\nNote: if you stop here, no Kubernetes changes will actually be deployed.]
prod_diff[invoke diff renders on prod PR]
prod_invoke[invoke releases to prod]
pr -- Yes --> candidates_branch -- "Open PR from candidates/branch-name to releases/test" --> branch_diff -- "Merge candidate PR to releases/test" --> branch_invoke -- Merge original PR to main after review and testing --> candidates_main -- "Open PR from candidates/main to releases/prod" --> prod_diff -- "Merge candidate PR to releases/prod" --> prod_invoke
pr -- "No; merge to main after review" --> candidates_main
class pr initial
class branch_invoke,prod_invoke deploy
```
See [`kubernetes/README.md`](../kubernetes/README.md#gitops) for details on the pull request workflow for previewing and deploying Kubernetes changes.

0 comments on commit 3ccbe31

Please sign in to comment.