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.

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

feat: Drop support of ocaml_version: "minimal" #75

Merged
merged 1 commit into from
Jun 28, 2022
Merged

Conversation

erikmd
Copy link
Member

@erikmd erikmd commented Jun 20, 2022

As the docker-coq-action is intended to act as a GHA facade (to simplify the CI testing of opam projects using a Docker-Coq image or a custom one), and as the mapping between valid coq_version and ocaml_version already is the responsibility of the Docker-Coq registry, it appears irrelevant to also maintain one similar mapping in docker-coq-action's entrypoint.sh.

Still, the value ocaml_version: "minimal" can be safely emulated with:

- uses: coq-community/docker-coq-action@v1
  with:
    ocaml_version: "4.05"
      # for 8.10 <= coq_version <= 8.15
      #
      # or:
      #
    ocaml_version: "4.09-flambda"
      # for coq_version >= 8.16

Finally, it can be noted that setting ocaml_version: "default" is useful to directly rely on Docker-Coq's default tag, regarding the ocaml version: see https://github.com/coq-community/docker-coq/wiki#ocaml-versions-policy

As the docker-coq-action is intended to act as a GHA *facade* (to simplify
the CI testing of opam projects using a Docker-Coq image or a custom one),
and as the mapping between valid `coq_version` and `ocaml_version` already
is the responsibility of the Docker-Coq registry, it appears irrelevant to
also maintain one similar mapping in docker-coq-action's `entrypoint.sh`.

Still, the value `ocaml_version: "minimal"` can be safely emulated with:

```
- uses: coq-community/docker-coq-action@v1
  with:
    ocaml_version: "4.05"
      # for 8.10 <= coq_version <= 8.15
      #
      # or:
      #
    ocaml_version: "4.09-flambda"
      # for coq_version >= 8.16
```

Finally, it can be noted that setting `ocaml_version: "default"` is useful
to directly rely on Docker-Coq's default tag, regarding the ocaml version:
see https://github.com/coq-community/docker-coq/wiki#ocaml-versions-policy
@erikmd erikmd added the fix label Jun 20, 2022
@erikmd erikmd self-assigned this Jun 20, 2022
@erikmd
Copy link
Member Author

erikmd commented Jun 20, 2022

When this PR will be merged: minor version bump → v1.4.0 (Unlike for PR #39: patch level bump)

@erikmd erikmd merged commit ee8f327 into master Jun 28, 2022
@erikmd erikmd deleted the drop-minimal branch June 28, 2022 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant