Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
- Add missing step for setting up local service
- Remove outdated "experimental" warning
  • Loading branch information
shonfeder authored and punchagan committed Jul 16, 2024
1 parent f7a5243 commit ff26b00
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
# opam-repo-ci

Status: **experimental**

This is an [OCurrent][] pipeline that tests submissions to [opam-repository][].

To test locally you will need a local copy of the [opam-repository][] Git repo. Run the `opam-repo-ci-local` command (you might need to increase the limit on the number of open files):
To get set up running the service locally for the first time:

```
- Obtain a local copy of the [opam-repository][] Git repo.
- Create the directory `capnp-secrets` in the root of this project (or wherever
you intend to run the service from).
- (Possibly) increase the limit on the number of open files, by setting
`ulimit`.

``` sh
mkdir capnp-secrets
ulimit -n 102400
```

Then you can run the `opam-repo-ci-local` command via dune:

```
dune exec -- opam-repo-ci-local \
--confirm harmless \
--repo REPO-PATH \
--branch BRANCH-NAME \
--capnp-address tcp:127.0.0.1:5001
--capnp-address tcp:127.0.0.1:5001 \
--verbosity info
```

If you would just like to lint your submission locally, you can add the `--lint-only` flag to the command above.
Expand Down

0 comments on commit ff26b00

Please sign in to comment.