Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coq/opam
Archive for all Coq related OPAM packages organized in various repositories
https://github.com/coq/opam
coq opam opam-repository
Last synced: about 1 month ago
JSON representation
Archive for all Coq related OPAM packages organized in various repositories
- Host: GitHub
- URL: https://github.com/coq/opam
- Owner: coq
- License: lgpl-2.1
- Created: 2015-05-27T09:58:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T18:52:42.000Z (7 months ago)
- Last Synced: 2024-04-12T21:30:32.542Z (7 months ago)
- Topics: coq, opam, opam-repository
- Language: OCaml
- Homepage: https://coq.inria.fr/opam/www/
- Size: 10.9 MB
- Stars: 118
- Watchers: 19
- Forks: 157
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# opam archive for Coq
All [opam](https://opam.ocaml.org) repositories for Coq packages live here.
Packages are organized according to the [layout](https://coq.inria.fr/opam-layout.html):
* `released`: packages for officially released versions of Coq libraries and Coq extensions.
* `core-dev`: packages for development versions of Coq.
* `extra-dev`: packages for development versions of Coq libraries and Coq extensions.
We welcome pull requests to the `released` repository adding any Coq-related package that is compatible
with a [released version of Coq](https://github.com/ocaml/opam-repository/tree/master/packages/coq).
Besides _libraries_ of general interest, this also includes _paper artifacts_ and other
_specialized formalizations_ that are not necessarily expected to be immediately reusable
by others.
## Usage
To activate the repositories:
* `released` (recommended default):
```
opam repo add coq-released https://coq.inria.fr/opam/released
```
* `core-dev`:
```
opam repo add coq-core-dev https://coq.inria.fr/opam/core-dev
```
* `extra-dev`:
```
opam repo add coq-extra-dev https://coq.inria.fr/opam/extra-dev
```
## Adding packages
See the [documentation](https://coq.inria.fr/opam-packaging.html) for how to add a package.
You can also look at existing [pull requests](https://github.com/coq/opam-coq-archive/pulls)
to see how others are adding packages.
## Coq Platform
The `released` opam archive is a key component of the [Coq Platform](https://github.com/coq/platform),
a distribution of Coq together with a curated set of libraries and plugins.
After installing the Platform using scripts (as opposed to via a binary installer),
additional packages in the `released` opam archive can be installed manually without the
need for repository activation.
## Website and opam metadata
The `scripts/archive2web.ml` program generates the JSON file
`coq-packages.json` by looking at the `opam` files.
In particular, it uses the `tags` field of an `opam` file as follows:
1. strings beginning with `keyword:` are considered as `keywords`
2. strings beginning with `category:` are considered as `categories`
3. a string beginning with `logpath:` is considered the Coq logical path prefix
4. a string beginning with `date:` is the date the software was last updated
(not the package definition)
Example:
```
tags: [
"keyword:cool"
"keyword:stuff"
"category:Miscellaneous/Coq Use Examples"
"logpath:MyPrefix"
"date:1992-12-22"
]
```
The `homepage:`, `author:`, `maintainer:`, and `doc:` fields are
also used to generate the package entry.
The JSON file is generated during continuous integration and
[copied to the website](https://coq.inria.fr/opam/coq-packages.json).
JavaScript code on the website then loads it to dynamically generate
the content of the website on the client side.
See also [CEP3](https://github.com/coq/ceps/blob/master/text/003-opam-metadata.md) and
the [deployed website](https://coq.inria.fr/opam/www/).
## Continuous integration
Incoming pull requests are tested on GitLab CI. **@coqbot** pushes any opened
or synchonized pull request to a branch named `pr-` on GitLab. It will
trigger a CI build. If the CI build runs for too long and times out, any
member of the Coq organization of GitLab can start it again using the "Run
Pipeline" green button at .
This will then build only on runners without pre-set timeouts (the Coq Pyrolyse
server). It may still time out if the build takes longer than the GitLab
project's timeout setting (24 hours). To skip some packages the first PR
message can contain a line such as `ci-skip: p1.v1 p2.v2` where `p1` and `p2` are package names, and `v1` and `v2` are versions.