Skip to content

Commit

Permalink
Merge pull request #149 from coq-community/ci-difference
Browse files Browse the repository at this point in the history
add FAQ item on Coq's CI
  • Loading branch information
palmskog authored Jul 27, 2023
2 parents e363fc1 + 6581a1c commit d743b7c
Showing 1 changed file with 29 additions and 15 deletions.
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,30 +108,25 @@ editorial work.

### Position in the Coq ecosystem ###

- **What is the relation to coq-contribs?**
- **What is the relation to Coq's Continuous Integration (CI)?**

Coq's [contribs][contribs] represent the legacy distribution, compatibility testing
and maintenance model. There used to be a form allowing users to submit a package
that the Coq development team would then maintain. While distribution now
happens through the Coq package index and compatibility testing using
[Coq's CI][Coq-CI], maintenance of legacy contribs is done less regularly.

coq-community is a proposed replacement for the long-term maintenance of
Coq packages. Whereas contribs were maintained by the Coq development team,
coq-community is managed by the user community. We encourage users to
“adopt” a package (including a legacy contrib) and to push the meaning of
“maintenance” further than simply ensuring that the package continues to
compile with newer Coq versions.
[Coq's CI][Coq-CI] systematically tests a collection of external libraries
and plugins for regression and compatiblity breakage with each proposed change to
Coq before integration. When a library or plugin in Coq's CI breaks, Coq developers
or contributors will send patches or give instructions how to adapt to the proposed
change. A [subset][coq-community-ci] of coq-community packages are included in
Coq's CI, and the process of fixing such packages that break is straightforward
since Coq developers can themselves integrate the required changes.

- **What is the relation to the Coq package index?**

The [Coq package index](https://coq.inria.fr/packages) is the present
opam-based way of distributing Coq packages. As such, all packages of
way of distributing Coq packages using [opam][opam]. As such, all packages of
coq-community are meant to be listed in the Coq package index.

- **What is the relation to the Coq Platform?**

The [Coq Platform][platform] is a continuously developed distribution of
The [Coq Platform][platform] is a continuously developed opam-based distribution of
Coq together with a curated selection of generally useful packages. The
Platform is currently the officially recommended way to install Coq. To ensure
that packages are compatible with Coq over time, Platform package maintainers
Expand All @@ -142,6 +137,21 @@ editorial work.
the Platform. To the Coq Platform, coq-community is one organization among many
that host Platform packages.

- **What is the relation to coq-contribs?**

Coq's [contribs][contribs] represent the legacy distribution, compatibility testing
and maintenance model. There used to be a form allowing users to submit a package
that the Coq development team would then maintain. While distribution now
happens through the Coq package index and compatibility testing is done via
Coq's CI, maintenance of legacy contribs is done less regularly.

coq-community is a proposed replacement for the long-term maintenance of
Coq packages. Whereas contribs were maintained by the Coq development team,
coq-community is managed by the user community. We encourage users to
“adopt” a package (including a legacy contrib) and to push the meaning of
“maintenance” further than simply ensuring that the package continues to
compile with newer Coq versions.

### Best practices ###

- **Do the projects of coq-community need to have some Continous Integration (CI) setup?**
Expand Down Expand Up @@ -264,3 +274,7 @@ Is anything still unclear? Please [open an issue][meta] or
[platform]: https://github.com/coq/platform

[coq-community-platform]: https://github.com/search?q=topic%3Acoq-platform+org%3Acoq-community&type=Repositories

[coq-community-ci]: https://github.com/search?q=topic%3Acoq-ci+org%3Acoq-community&type=Repositories

[opam]: https://opam.ocaml.org

0 comments on commit d743b7c

Please sign in to comment.