Skip to content

Commit

Permalink
More doc updates (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
ipv1337 committed Jun 19, 2023
1 parent 4a0ba0e commit bb22ad3
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Monorepo Blueprint
# mnorepo

A place to develop monorepo patterns.

## Overview

Expand All @@ -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)
Expand All @@ -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

Expand Down Expand Up @@ -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/
7 changes: 4 additions & 3 deletions projects/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
9 changes: 6 additions & 3 deletions projects/go_devops_cli_app/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# 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
- [ ] Gather feedback from beta testers

## 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)

0 comments on commit bb22ad3

Please sign in to comment.