Skip to content

Commit

Permalink
Correct docs for new users (#896)
Browse files Browse the repository at this point in the history
  • Loading branch information
benmandrew authored Oct 23, 2023
1 parent be4c41c commit 4bada58
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To add the CI to your own project:
1. Go to https://github.com/apps/ocaml-ci and install the app for your GitHub user.
2. Configure just the repositories you want to test (start with one!). If you select `All Repositories` we won't build anything.
3. Ask us to add you to the alpha-testers list by submitting a PR against this
repository adding yourself to `--github-account-allowlist` in `stack.yml`. eg https://github.com/ocurrent/ocaml-ci/pull/346. Additionally, please add yourself to `deploy-data/github-organisations.txt`.
repository adding yourself to `deploy-data/github-organisations.txt`.
4. Add a status badge from the OCaml-CI endpoint with:
```
[![OCaml-CI Build Status](https://img.shields.io/endpoint?url=https://ocaml.ci.dev/badge/<user>/<repo>/<branch>&logo=ocaml)](https://ocaml.ci.dev/github/<user>/<repo>)
Expand Down Expand Up @@ -150,7 +150,7 @@ To deploy code changes either from `master` or a branch:
To deploy changes to `stack.yml` run (assuming a docker context with sufficient access):

``` bash
docker -c ocaml.ci.dev stack deploy -c stack.yml ocaml-ci
make deploy-stack
```

## Opam repository updates
Expand Down

0 comments on commit 4bada58

Please sign in to comment.