Skip to content

Commit 897ac7b

Browse files
committed
update the readme to reference the new wcl package and deployment process
1 parent 7938429 commit 897ac7b

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
- [Getting Started](#getting-started)
55
- [Webstore Component Library](#webstore-component-library)
6+
- [Upgrading To The Latest Version](#upgrading-to-the-latest-version)
67
- [Component Library Dev Mode](#component-library-dev-mode)
78
- [Environment Variables](#environment-variables)
89
- [Authentication](#authentication)
@@ -12,7 +13,7 @@
1213
- [Testing](#testing)
1314
- [Jest](#jest)
1415
- [Cypress](#cypress)
15-
- [Cutting a New Release](#cutting-a-new-release)
16+
- [Deployment](#deployment)
1617

1718
---
1819

@@ -34,6 +35,16 @@ The `pages/api` directory is mapped to `/api/*`. Files in this directory are tre
3435
### Webstore Component Library
3536
The webstore requires a [React component library](https://reactjs.org/docs/react-component.html) of view components. That dependency is packaged and released independently.
3637

38+
#### Upgrading To The Latest Version
39+
In the terminal:
40+
``` bash
41+
# first check for whether there is an updated version
42+
yarn outdated @scientist-softserv/webstore-component-library # check the values under "current" and "latest"
43+
44+
# if there's an updated version
45+
yarn upgrade @scientist-softserv/webstore-component-library --latest
46+
```
47+
3748
#### Component Library Dev Mode
3849
Using the local github repository requires you to manually clone the component library to your computer, build, and link it:
3950

@@ -149,7 +160,7 @@ If you are creating an e2e test, it will live in the `cypress/e2e` directory. Co
149160
- do not ever commit this value
150161
- this value will need to be updated whenever the cookie expires, approximately once per month
151162

152-
## Cutting a New Release
163+
<!-- ## Cutting a New Release
153164
A git tag should exist for every release. We use `release-it` to automate the coordination of package.json and git tag.
154165
155166
If you want to release a new semver release run:
@@ -170,4 +181,7 @@ In order to deploy this new release to staging, use the command below
170181
``` bash
171182
# the tag is the semver release that was created above
172183
helm upgrade --install --kube-context=k3 --namespace=webstore-staging webstore-staging charts/webstore -f charts/webstore/values/webstore-staging.yaml --set=image.tag=X.X.X
173-
```
184+
``` -->
185+
186+
## Deployment
187+
We are currently using [Vercel](www.vercel.com) to auto deploy this app to our staging environment. The `main` branch is accessible at https://webstore-staging.vercel.app.

0 commit comments

Comments
 (0)