Skip to content

Commit a8ceaaf

Browse files
committed
update contributor docs to mention opam-repository pin upgrade process
1 parent b1a38e1 commit a8ceaaf

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/FOR_MAINTAINERS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Information for maintainers
22

3+
# Advancing the `opam-repository` pin
4+
5+
OCaml.org's dependencies are fixed through pinning `opam-repository` in the `dune-workspace` files, and in the `Dockerfile`. To update the repository pin,
6+
7+
1. change the commit hash in the main `dune-workspace` file, `dune-workspace` file of the playground, and in the `Dockerfile`
8+
2. delete the `dune.lock/` directory
9+
3. build the project
10+
4. make it very obvious in the PR updating the opam-repository pin that contributors need to re-run `dune pkg lock` and be aware that contributors may need to be told to do this
11+
312
# How we maintain the staging branch
413

514
To reduce the workload maintaining the `staging` branch in a good shape where

0 commit comments

Comments
 (0)