Code Monkey home page Code Monkey logo

template-monorepo's Introduction

template-monorepo

This is a project to demonstrate tools which can be used to manage a monorepo.

deps

You'll need to have please.build installed.


platforms

macOS

I use colima to run the app locally.

linux [WIP]

I use MicroK8S to run the app on Linux.

You'll need to install it and also enable the built-in registry to run the app, which can be done with microk8s enable registry


inject secrets

. ./template.envrc

create services

to deploy the app, create the services

plz build //svc/...
plz run parallel //svc/api //svc/documentation

[extra step for linux] push images to docker registry

Because the images need to be on the microk8s docker registry for this to work, we need to push the images manually. (need to try and automate this later)

plz run parallel //svc/api:api_push //svc/documentation:documentation_push

deploy to kubernetes

# create the k8s namespace
kubectl create namespace template-monorepo

plz run parallel //svc/api/k8s:k8s_push //svc/parser/k8s:k8s_push
plz run //svc/documentation/k8s:k8s_push

cleanup

plz run parallel //svc/api/k8s:k8s_cleanup //svc/documentation/k8s:k8s_cleanup

kubectl delete namespace template-monorepo

access the documentation site

on macos

use this command to forward the port from the documentation service

kubectl port-forward service/documentation -n $K8S_NAMESPACE 3000:80

you can navigate to http://localhost:3000

on linux

with microk8s on Linux, the services will directly be available on the NodePort so, no need to use port-forward.

You can get the port with

kubectl -n template-monorepo describe svc/documentation-svc | grep NodePort

template-monorepo's People

Contributors

mrsauravsahu avatar

Watchers

 avatar  avatar  avatar

template-monorepo's Issues

Workflows are referencing vulnerable actions

Hello, there!

As part of the university research we are currently doing regarding the security of Github Actions, we noticed that one or many of the workflows that are part of this repository are referencing vulnerable versions of the third-party actions. As part of a disclosure process, we decided to open issues to notify GitHub Community.

Please note that there are could be some false positives in our methodology, thus not all of the open issues could be valid. If that is the case, please let us know, so that we can improve on our approach. You can contact me directly using an email: ikoishy [at] ncsu.edu

Thanks in advance

  1. The workflow aspnetcore-service.ci.yml is referencing action gittools/actions/gitversion/setup using references v0.9.7. However this reference is missing the commit 90150b4 which may contain fix to the vulnerability.
  2. The workflow aspnetcore-service.ci.yml is referencing action gittools/actions/gitversion/execute using references v0.9.7. However this reference is missing the commit 90150b4 which may contain fix to the vulnerability.
  3. The workflow nestjs-service.ci.yml is referencing action gittools/actions/gitversion/setup using references v0.9.7. However this reference is missing the commit 90150b4 which may contain fix to the vulnerability.
  4. The workflow nestjs-service.ci.yml is referencing action gittools/actions/gitversion/execute using references v0.9.7. However this reference is missing the commit 90150b4 which may contain fix to the vulnerability.

The vulnerability fix that is missing by actions' versions could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider updating the reference to the action.

If you end up updating the reference, please let us know. We need the stats for the paper :-)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.