README.md

Getting started

1. Template out your repository in Org: commit-app-playground as a Public repository.
   _{It must be both public and in the org in order to access deployment credentials from Github actions}

2. Edit the zero-project.yml with name (it must be alpha-numeric and dashes only to be a valid k8s-namespace) then commit the change.
   _{Once Github action successfully run you will nolonger see this readme in your repository but instead of your own example project.}

3. Once you commit the change containing zero-project.yml, Github actions will be triggered and rewrite the repository becoming the templated repo

4. You are suggested to clone the repo ONLY after you have committed the zero-project.yml change, since the Github actions will rewrite the git history and will become a non-fast forward change.

Notes:

If your static site is a

Single page app
_{(eg. angular / react)}

The built static site will be served and accessible via <name>.onboarding.dev OR <name>.spa.onboarding.dev

Traditional static site
_{(served on html files instead of purely index.html, eg. Next.js static site)}

The built static site will be available in <name>.static.onboarding.dev

---

Credits

_{- stefanbuck for inspiration of using Github actions to template out a repo}