docs: update README to reflect docker-opam-action rename#107
Open
Justme0606 wants to merge 1 commit into
Open
Conversation
Zimmi48
reviewed
May 6, 2026
Zimmi48
left a comment
Zimmi48
left a comment
Member
There was a problem hiding this comment.
I noticed a few things that would need to be updated, although not all of them are related to this PR, so feel free to delay some of these changes to a later PR. The comments that are most relevant to the current PR are the one on the title, and those related to the contributing guide and code of conduct.
| [example-link]: https://github.com/erikmd/docker-coq-github-action-demo | ||
|
|
||
| [contributing-shield]: https://img.shields.io/badge/contributions-welcome-%23f7931e.svg | ||
| [contributing-link]: https://github.com/coq-community/manifesto/blob/master/CONTRIBUTING.md |
Member
There was a problem hiding this comment.
This link should be removed or replaced.
| [contributing-link]: https://github.com/coq-community/manifesto/blob/master/CONTRIBUTING.md | ||
|
|
||
| [conduct-shield]: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-%23f15a24.svg | ||
| [conduct-link]: https://github.com/coq-community/manifesto/blob/master/CODE_OF_CONDUCT.md |
Member
There was a problem hiding this comment.
Same. In this case, we can point to https://rocq-prover.org/policies/code-of-conduct.
| | | GitHub repo | Type | Docker Hub | | ||
| | --- | ----------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------- | | ||
| | ⊙ | [docker-opam-action](https://github.com/rocq-prover/docker-opam-action) | GitHub Action | N/A | | ||
| | ↳ | [docker-rocq](https://github.com/coq-community/docker-rocq) | Dockerfile | [`rocq/rocq-prover`](https://hub.docker.com/r/rocq/rocq-prover/) | |
Member
There was a problem hiding this comment.
Suggested change
| | ↳ | [docker-rocq](https://github.com/coq-community/docker-rocq) | Dockerfile | [`rocq/rocq-prover`](https://hub.docker.com/r/rocq/rocq-prover/) | | |
| | ↳ | [docker-rocq](https://github.com/rocq-community/docker-rocq) | Dockerfile | [`rocq/rocq-prover`](https://hub.docker.com/r/rocq/rocq-prover/) | |
| | --- | ----------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------- | | ||
| | ⊙ | [docker-opam-action](https://github.com/rocq-prover/docker-opam-action) | GitHub Action | N/A | | ||
| | ↳ | [docker-rocq](https://github.com/coq-community/docker-rocq) | Dockerfile | [`rocq/rocq-prover`](https://hub.docker.com/r/rocq/rocq-prover/) | | ||
| | ↳ | [docker-base](https://github.com/coq-community/docker-base) | Dockerfile | [`rocq/base`](https://hub.docker.com/r/rocq/base/) | |
Member
There was a problem hiding this comment.
Suggested change
| | ↳ | [docker-base](https://github.com/coq-community/docker-base) | Dockerfile | [`rocq/base`](https://hub.docker.com/r/rocq/base/) | | |
| | ↳ | [docker-base](https://github.com/rocq-community/docker-base) | Dockerfile | [`rocq/base`](https://hub.docker.com/r/rocq/base/) | |
| | ↳ | Debian | Linux distro | [`debian`](https://hub.docker.com/_/debian/) | | ||
|
|
||
| For more details about these images, see the | ||
| [docker-coq wiki](https://github.com/coq-community/docker-coq/wiki). |
Member
There was a problem hiding this comment.
Suggested change
| [docker-coq wiki](https://github.com/coq-community/docker-coq/wiki). | |
| [docker-coq wiki](https://github.com/rocq-community/docker-coq/wiki). |
| @@ -1 +1 @@ | |||
| # Docker-Coq GitHub Action | |||
Member
There was a problem hiding this comment.
Suggested change
| # Docker-Opam GitHub Action |
| The `docker-coq-action` provides built-in support for `opam` builds. | ||
| The `docker-opam-action` provides built-in support for `opam` builds. | ||
|
|
||
| `coq` is built on-top of `ocaml` and so `coq` projects use `ocaml`'s |
Member
There was a problem hiding this comment.
Suggested change
| `coq` is built on-top of `ocaml` and so `coq` projects use `ocaml`'s | |
| Rocq is built on-top of OCaml and so Rocq projects use OCaml's |
| This GitHub Action supports `opam` out of the box. | ||
| If your project does not already have a `coq-….opam` file, you might | ||
| generate one such file by using the corresponding template gathered in | ||
| [coq-community/templates](https://github.com/coq-community/templates#readme). |
Member
There was a problem hiding this comment.
Suggested change
| [rocq-community/templates](https://github.com/rocq-community/templates#readme). |
| [coq-community/templates](https://github.com/coq-community/templates#readme). | ||
|
|
||
| This `.opam` file can then serve as a basis for submitting releases in | ||
| [coq/opam-coq-archive](https://github.com/coq/opam-coq-archive), and |
Member
There was a problem hiding this comment.
Suggested change
| [rocq-prover/opam](https://github.com/rocq-prover/opam) repository, and |
| This `.opam` file can then serve as a basis for submitting releases in | ||
| [coq/opam-coq-archive](https://github.com/coq/opam-coq-archive), and | ||
| related guidelines (including the required **`.opam` metadata**) are | ||
| available in <https://coq.inria.fr/opam-packaging.html>. |
Member
There was a problem hiding this comment.
Suggested change
| available in <https://rocq-prover.org/docs/opam-packaging>. |
Zimmi48
reviewed
May 6, 2026
|
|
||
| The supported compilers w.r.t. each version of Coq are documented in the | ||
| [OCaml-versions policy](https://github.com/coq-community/docker-coq/wiki#ocaml-versions-policy) section of the `docker-coq` wiki. | ||
| [OCaml-versions policy](https://github.com/rocq-prover/docker-coq/wiki#ocaml-versions-policy) section of the `docker-coq` wiki. |
Member
There was a problem hiding this comment.
This link shouldn't have been changed (until this wiki moves elsewhere).
Zimmi48
reviewed
May 7, 2026
| #### `opam_file` | ||
|
|
||
| *Optional* | ||
| _Optional_ |
Member
There was a problem hiding this comment.
BTW, you have a lot of spurious changes in the diff like this one. If you can configure your auto-formatter to use * instead of _ for italic, it would reduce significantly the size of the diff.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.