Skip to content

Commit

Permalink
update maintenance guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Imod7 committed Oct 8, 2024
1 parent a4f0d61 commit bec7dba
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion guides/MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,12 @@ Review the security alerts raised by Dependabot [here](https://github.com/parity

**NOTE**: This dependency is mentioned separately from the general ones because it is critical, requiring manual checks and thorough testing before updating.

**Frequency**: Monthly or longer.
### Express version
- Check if there is a new major version of [Express](https://github.com/expressjs/express).
- Update the version by running the command `yarn add express@^X.X.X`, e.g. `yarn add express@^5.0.0`.
- After upgrading, we can do the usual sanity checks (e.g. `yarn`, `yarn dedupe`, `yarn build`, `yarn lint --fix`).

**Frequency**: Yearly or longer.

### Keep `substrate-js-dev` repository up to date
Sidecar is using [substrate-js-dev](https://github.com/paritytech/substrate-js-dev) repository as a dependency. For instance, running `yarn lint` in sidecar triggers the `substrate-dev-run-lint` script which is defined [here](https://github.com/paritytech/substrate-js-dev/blob/58fe47c55610a797c2e780c5cfef0f3dd2fae7ca/scripts/substrate-dev-run-lint.cjs). Therefore, it is important to keep this repository's dependencies up to date as well. This can be done by running `yarn upgrade-interactive` and following the process mentioned in the previous step. Last, we would need to make a new release in that repository and then update the package version in Sidecar.
Expand Down Expand Up @@ -113,3 +118,6 @@ The frequency is somewhat flexible.
- Check Public instances of Sidecar.
- Docker images of Sidecar.
- Review repository branches.

- Yearly
- Express version.

0 comments on commit bec7dba

Please sign in to comment.