diff --git a/README.md b/README.md index 18fbc47..a839d97 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# Monorepo Blueprint +# mnorepo + +A place to develop monorepo patterns. ## Overview @@ -8,18 +10,20 @@ Unlike other examples and demos out in the wild, we have a loftier goals. If you ### Continuous Development -- [x] [Skaffold](https://github.com/GoogleContainerTools/skaffold) +- [x] [Skaffold for continuous development](https://skaffold.dev/docs/quickstart/#use-skaffold-for-continuous-development) + - [ ] [Skaffold for CI](https://skaffold.dev/docs/quickstart/#use-skaffold-for-continuous-integration) + - [ ] [Skaffold for CD](https://skaffold.dev/docs/quickstart/#use-skaffold-for-continuous-delivery) - [x] [Bazel]() - [ ] [Pants]() -### Continous Integration +### Continuous Integration - [x] [Github Actions](https://docs.github.com/en/actions) - [ ] [Cloud Build](https://cloud.google.com/build) - [ ] [CircleCI](https://circleci.com/) - [ ] [Harness](https://www.harness.io/) -### Continous Deployment +### Continuous Deployment - [ ] [Argo CD](https://github.com/argoproj/argo-cd) - [ ] [Cloud Deploy](https://cloud.google.com/deploy) @@ -33,6 +37,7 @@ Unlike other examples and demos out in the wild, we have a loftier goals. If you 1. Download latest [bazelisk](https://bazel.build/install/bazelisk) 1. Download latest [skaffold](https://skaffold.dev/docs/install/) +1. Download latest [minikube](https://minikube.sigs.k8s.io/docs/start/) ## Motivation @@ -112,3 +117,5 @@ monorepo/ ## References - https://github.com/aspect-build/bazel-examples/tree/main +- https://s.itho.me/ccms_slides/2022/9/27/8dc835fc-b6f6-4656-84d4-53df725d1d6e.pdf +- https://nubenetes.com/kubernetes-based-devel/ diff --git a/projects/README.md b/projects/README.md index b537b57..e47f2a3 100644 --- a/projects/README.md +++ b/projects/README.md @@ -9,6 +9,7 @@ Where all project applications are implemented. ## Project Reference Table -| Project Name | Short Description | Owner(s) | -|--------------|-------------------|----------| -| Example | My example project | [John Doe](mailto://john.doe@email) | +| Project Name | Short Description | State | Owner(s) | +|--------------|-------------------|-------|----------| +| Example | My example project | Production | [John Doe](mailto://john.doe@email) | +| go_devops_cli_app | Example golang project with skaffold & bazel | Development | [James Nguyen](mailto://james.nguyen@flyrlabs.com) | diff --git a/projects/go_devops_cli_app/README.md b/projects/go_devops_cli_app/README.md index f321caa..99d2023 100644 --- a/projects/go_devops_cli_app/README.md +++ b/projects/go_devops_cli_app/README.md @@ -1,10 +1,12 @@ # Overview -Template for creating FastAPI projects. +Template for creating Golang projects. ## Roadmap -- [ ] Setup basic templating +- [x] Setup basic templating + - [x] Use latest bazel and modules including rules_oci + - [x] Use latest skaffold with bazel build - [ ] Research Cookiecutter - [ ] Bake-in everything including best practices - [ ] Test and validate framework @@ -12,4 +14,5 @@ Template for creating FastAPI projects. ## Known issues -- [ ] None yet +- [ ] skaffold dev does not yet work with latest rules_oci + - [ ] bazel-contrib/rules_oci issue [#265](https://github.com/bazel-contrib/rules_oci/issues/265)