From c9287439178b05116bbed9622818491c3bfe0106 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 5 Dec 2023 23:59:18 +0100 Subject: [PATCH] includes deployment instructions [readme] --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3bb9a43..a58e049 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,24 @@ 1. Run `yarn` to install dependencies ([install yarn if not available](https://yarnpkg.com/getting-started/install)) 2. Run `yarn dev` to start a dev server +## Deploy + +Deployments are handled automatically with github actions (see the pipelines in `.github/workflows/`). + +Pushing to the `main` branch will update production while pushing to `staging` will update staging: +```perl +push to /main → updates services.kukai.app +push to /staging → updates staging.services.kukai.app +``` + ## Modify -1. Navigate to the path are looking for (i.e. `/version` corresponds to `/v1/version) +1. Navigate to the path are looking for (i.e. `/version` corresponds to `/v1/version`) 2. Navigate to the `storage` folder, modify the `.json` file 3. Test locally with `yarn dev` (i.e. `localhost:8787/v1/version`) -## Deploy -1. Make sure you have `npm` installed, this comes with the `npx` package manager -2. Run `npx wrangler login` -3. Run `npx wrangler publish --env staging` for deploying your changes to the `staging` environment. (See `wrangler.toml` for more options) -Use `--env production` to deploy to production, or skip the `--env` to deploy to a temporary `.dev` url for further testing. -Optionally, create a `staging` and a `release` tag/branch to keep track of releases and versions. + + +