Skip to content

Commit fb176bc

Browse files
committed
Update dev instructions
1 parent 7b02b2e commit fb176bc

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,28 @@ The Diamond Light Source developer portal, built with backstage for deployment o
1919
- Set `remote.containers.dockerPath` to `podman`
2020
- Set `remote.containers.dockerComposePath` to your `docker-compose`
2121
- Disable buildkit by adding `export DOCKER_BUILDKIT=0` to your `~/.bashrc`
22-
- Open Development Container
2322
- Create a `.env` file in the `.devcontainer` directory containing the [necessary secrets](#necessary-secrets)
23+
- Open Development Container
2424
- Install package dependencies with `yarn --cwd backstage install`
2525
- Start the app, with `yarn --cwd backstage dev`
2626

27+
## Contributing changes
28+
29+
The following can be run locally to see if changes will pass CI
30+
31+
- `yarn --cwd backstage run test`
32+
- `a` when prompted to run all tests
33+
- `yarn --cwd backstage run prettier . --check`
34+
- `yarn --cwd backstage backstage-cli repo lint`
35+
36+
## Updating Backstage version
37+
38+
After package install, backstage package dependencies can be updated with
39+
40+
`yarn --cwd backstage backstage-cli versions:bump`
41+
42+
https://backstage.io/docs/getting-started/keeping-backstage-updated
43+
2744
## Deploying on Kubernetes (Diamond Light Source)
2845

2946
- Access the cluster with `module load argus`

0 commit comments

Comments
 (0)