-
Notifications
You must be signed in to change notification settings - Fork 349
(docs) add a page about the OCaml Infrastructure #3107
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
0b7a440
a8f9b1a
952fedc
631dbbc
2ac66d0
9cb22c8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,88 @@ | ||||||||||||||
--- | ||||||||||||||
id: "ocaml-infrastructure" | ||||||||||||||
short_title: "The OCaml Infrastructure" | ||||||||||||||
title: "The OCaml Infrastructure: Tools and Services for the OCaml Ecosystem" | ||||||||||||||
description: "An overview of the services that belong to the OCaml Infrastructure." | ||||||||||||||
category: "OCaml Infrastructure" | ||||||||||||||
--- | ||||||||||||||
|
||||||||||||||
The OCaml ecosystem is supported by a [robust infrastructure built around OCurrent](https://github.com/ocurrent/overview). The OCaml Infrastructure powers many essential services that OCaml developers rely on daily. | ||||||||||||||
|
||||||||||||||
## What is OCurrent? | ||||||||||||||
|
||||||||||||||
[OCurrent](https://ocurrent.org) is an OCaml eDSL for creating processing pipelines that automatically adjust when their inputs change. For example, when a Git repository is updated, OCurrent pipelines can automatically rebuild, test, and deploy the changes without manual intervention. | ||||||||||||||
|
||||||||||||||
## OCaml Infrastructure Services | ||||||||||||||
|
||||||||||||||
The OCaml infrastructure services can be grouped into three main categories: Community infrastructure services, services for individual projects, and infrastructure operation services. Here we present a brief overview of the major services from the first two categories. | ||||||||||||||
|
||||||||||||||
### Services for Individual Projects | ||||||||||||||
|
||||||||||||||
These services used for your own projects to help with reproducible builds, testing, benchmarking, and continuous integration: | ||||||||||||||
|
||||||||||||||
#### Docker Base Images | ||||||||||||||
|
||||||||||||||
**Service:** [docker-base-images](https://github.com/ocurrent/docker-base-images) | ||||||||||||||
|
||||||||||||||
**Website:** [images.ci.ocaml.org](https://images.ci.ocaml.org) | ||||||||||||||
Comment on lines
+25
to
+27
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if this should be something like
Suggested change
or maybe "Repo"/"Service" or somtehing? I'm thinking this because the "Website" is actually a view into the running service, but the github repo is just the source code from which the service is deployed. |
||||||||||||||
|
||||||||||||||
This service builds the official `ocaml/opam` Docker images for various Linux distributions, OCaml versions, compiler flags, and architectures (including x86, ARM, PowerPC, s390x, and RISC-V). These images provide a consistent environment for development and testing and are used by many other CI services. | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since I think it is nice to link the first time something is mentioned:
Suggested change
|
||||||||||||||
|
||||||||||||||
**Using the pre-built OCaml Docker images:** You can view the available [pre-built Docker images for various OCaml configurations at DockerHub](https://hub.docker.com/r/ocaml/opam). | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we are linking the main docker hub page when first mentioned above, maybe it is then helpful to have this go to
Suggested change
Which presents people with the list of platforms that is the topic here? |
||||||||||||||
|
||||||||||||||
#### OCaml-Multicore-CI | ||||||||||||||
|
||||||||||||||
**Service:** [ocaml-multicore-ci](https://github.com/ocurrent/ocaml-multicore-ci) | ||||||||||||||
|
||||||||||||||
**Website:** [ocaml-multicore.ci.dev](https://ocaml-multicore.ci.dev) | ||||||||||||||
|
||||||||||||||
Tests OCaml projects against multicore OCaml versions - particularly useful if you want to ensure your code is compatible with OCaml 5.x. | ||||||||||||||
|
||||||||||||||
**How to enable OCaml-Multicore-CI on your GitHub project:** Check out the [OCaml-Multicore-CI README on GitHub](https://github.com/ocurrent/ocaml-multicore-ci). | ||||||||||||||
Comment on lines
+33
to
+41
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have not been involved with this, but I don't know what its use case is beyond ocaml-ci now that 5 is out for some time and we are running ocaml 5.x in ocaml-ci. It doesn't seem to me that this is a service we want people thinking is maintained and available for their use on individual projects. |
||||||||||||||
|
||||||||||||||
### Community Infrastructure Services | ||||||||||||||
|
||||||||||||||
These services power the broader OCaml ecosystem, supporting package repositories, documentation, and other essential community resources: | ||||||||||||||
|
||||||||||||||
#### Package Submission CI (opam-repo-ci) | ||||||||||||||
|
||||||||||||||
**Service:** [opam-repo-ci](https://github.com/ocurrent/opam-repo-ci) | ||||||||||||||
|
||||||||||||||
**Website:** [opam.ci.ocaml.org](https://opam.ci.ocaml.org) | ||||||||||||||
|
||||||||||||||
Tests package submissions to the opam repository. When you submit a pull request to opam-repository, this service verifies that your package builds correctly and also tests all dependent packages to ensure compatibility. | ||||||||||||||
|
||||||||||||||
**Maintaining compatibility for packages in the opam-repository:** After publishing a package by creating a GitHub release and opening an opam-repository PR (e.g. by [using `dune-release`](/publishing-packages-w-dune)), monitor your opam-repository PR to ensure all tests pass. | ||||||||||||||
|
||||||||||||||
#### Documentation CI | ||||||||||||||
|
||||||||||||||
**Service:** [ocaml-docs-ci](https://github.com/ocurrent/ocaml-docs-ci) | ||||||||||||||
|
||||||||||||||
**Website:** [docs.ci.ocaml.org](https://docs.ci.ocaml.org) | ||||||||||||||
|
||||||||||||||
Builds **documentation for all packages in the opam repository**, with correct cross-package linking. After publishing your package to opam-repository, the documentation will automatically be built and published to the [OCaml.org website's package area](https://ocaml.org/packages). | ||||||||||||||
|
||||||||||||||
#### Health Check Services | ||||||||||||||
|
||||||||||||||
* [check.ci.ocaml.org](https://check.ci.ocaml.org): Regularly tests that all packages in the opam repository still build correctly. This service is used by OCaml compiler developers when preparing major changes like new OCaml compiler releases. **GitHub**: [opam-health-check](https://github.com/ocurrent/opam-health-check) | ||||||||||||||
* [dune.check.ci.dev](https://dune.check.ci.dev): Regularly tests OCaml packages with the Dune build system to ensure compatibility and correctness. | ||||||||||||||
* [windows.check.ci.dev](https://windows.check.ci.dev): Tests OCaml packages on Windows platforms to identify Windows-specific issues in the OCaml ecosystem and to assist package maintainers in supporting Windows environments. | ||||||||||||||
* [freebsd.check.ci.dev](https://freebsd.check.ci.dev): This service helps package maintainers identify and fix FreeBSD-specific issues in their packages, by testing OCaml packages on FreeBSD to ensure compatibility. | ||||||||||||||
* [oxcaml.check.ci.dev](https://oxcaml.check.ci.dev): Tests OCaml packages with OxCaml, an alternative OCaml compiler implementation. This service helps identify compatibility issues between packages and the OxCaml compiler variant. | ||||||||||||||
|
||||||||||||||
## Platform Support | ||||||||||||||
|
||||||||||||||
The OCaml infrastructure supports building and testing on multiple platforms: | ||||||||||||||
- Linux: Various distributions (Debian, Ubuntu, Alpine, etc.) | ||||||||||||||
- Architecture diversity: x86_64, ARM64, ARM32, PowerPC, s390x, RISC-V | ||||||||||||||
- macOS: Through [macos-infra](https://github.com/ocurrent/macos-infra) | ||||||||||||||
- FreeBSD: Through [freebsd-infra](https://github.com/ocurrent/freebsd-infra) | ||||||||||||||
|
||||||||||||||
## Getting Involved | ||||||||||||||
|
||||||||||||||
The OCaml infrastructure is open source and welcomes contributions. You can: | ||||||||||||||
- [Contribute to the various codebases on GitHub](https://github.com/ocurrent/overview) | ||||||||||||||
- Report issues or suggest improvements on [discuss.ocaml.org](https://discuss.ocaml.org) | ||||||||||||||
- Deploy the tools locally to test your projects (see the individual documentation of the service you want to run) | ||||||||||||||
|
||||||||||||||
For more information on OCurrent and these services, visit [ocurrent.org](https://ocurrent.org) or explore the [OCurrent GitHub organization](https://github.com/ocurrent). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.