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.

Sign up for GitHub

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

ref: clarify keys with examples #33

Merged
merged 4 commits into from
May 27, 2020
Merged

ref: clarify keys with examples #33

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73f8047
ref: clarify tested_coq_opam_versions
liyishuai May 26, 2020
36e1a85
ref: clarify supported_coq_versions
liyishuai May 26, 2020
6582e88
ci: lint with stable version
liyishuai May 27, 2020
5b8ddf0
Document some more fields.
Zimmi48 May 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Yaml Lint
on: [push]
on: [push, pull_request]
jobs:
lintAllTheThings:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion coq-action.yml.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
matrix:
coq_version:
{{# tested_coq_opam_versions }}
- {{ version }}
- '{{ version }}'
{{/ tested_coq_opam_versions }}
ocaml_version: ['minimal']
fail-fast: false
Expand Down
4 changes: 1 addition & 3 deletions coq.opam.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ depends: [
{{# supported_ocaml_versions }}
"ocaml" {{& opam }}
{{/ supported_ocaml_versions }}
{{# supported_coq_versions }}
"coq" {{& opam }}
{{/ supported_coq_versions }}
"coq" {{& supported_coq_versions.opam }}
{{# dependencies }}
{{# opam }}
"{{ name }}" {{& version }}
Expand Down
4 changes: 1 addition & 3 deletions extracted.opam.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ depends: [
{{# extracted_supported_ocaml_versions }}
"ocaml" {{& opam }}
{{/ extracted_supported_ocaml_versions }}
{{# supported_coq_versions }}
"coq" {{& opam }}
{{/ supported_coq_versions }}
"coq" {{& supported_coq_versions.opam }}
{{# dependencies }}
{{# opam }}
"{{ name }}" {{& version }}
Expand Down
22 changes: 21 additions & 1 deletion ref.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,13 @@ keys:
used:
- README.md
- opam:
required: true
required: false
description: >
Version formula including curly brackets:
https://opam.ocaml.org/doc/Manual.html#Common-file-format
Quote the string, otherwise confuse the parser.
examples:
- '{ >= "8.10" }'
used:
- coq.opam
- extracted.opam
Expand Down Expand Up @@ -248,6 +254,13 @@ keys:
item_fields:
- version:
required: true
description: >
Docker tag supported by coqorg/coq:
https://github.com/coq-community/docker-coq/wiki#supported-tags
Quote the strings, otherwise '8.10' becomes '8.1'.
examples:
- '8.11'
- 'dev'
used:
- .travis.yml
- documentation:
Expand Down Expand Up @@ -275,6 +288,13 @@ keys:
item_fields:
- version:
required: true
description: >
Docker tag supported by coqorg/coq:
https://github.com/coq-community/docker-coq/wiki#supported-tags
Quote the strings, otherwise '8.10' becomes '8.1'.
examples:
- '8.11'
- 'dev'
used:
- .travis.yml
- coq-action.yml
Expand Down