Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #340

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Update readme #340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
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