-
Notifications
You must be signed in to change notification settings - Fork 4
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
clarify readme #56
clarify readme #56
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Bruno-366, thanks for opening this!
I know that your PR is still in Draft mode, but I already left a few comments :)
BTW regarding my review comment w.r.t. the section title with action.yaml
, do you think you could also add a comment such as the following somewhere (e.g. just after ## Example
?) → feel free to rephrase anyway:
Using a GitHub Action in your GitHub repository amounts to committing a file
.github/workflows/your-workflow-name.yml
, e.g.,.github/workflows/build.yml
, containing (among others), a snippet such as:runs-on: ubuntu-latest # container actions require GNU/Linux […] ocaml_version: ${{ matrix.ocaml_version }}
Each field can be customized, see below for the documentation of those specific to the docker-coq-action, or the GitHub Actions official documentation for the standard fields involved in workflows.
Co-authored-by: Erik Martin-Dorel <[email protected]>
move the "optional" to the headings so that when scrolling/browsing and getting a quick overview, one can see that all the inputs (so far) are optional. If there ever is a required input this would make finding it while scrolling easier too
Question: what is the default to `export`?
two questions: what is default value for |
I think the remarks should maybe be moved so that they are before the inputs section, if reading them first makes understanding the inputs easier. |
Also the opam related information should have its own heading/section.
|
Indeed, why not. |
but there's already or maybe, you just mean move this section with a higher heading, such as
👍 good idea; you can commit this as is :) (maybe just capitalizing |
It's true that the current doc https://github.com/coq-community/docker-coq-action/tree/v1.2.3#export only mentions one example with a single variable, so this can be misleading. To be more precise:
− However note that there's an open feature wish suggesting to change the behavior (a.k.a. needing to make each extra export explicit) to some "automatic, implied export of everything": #54 − but I've not yet decided how to deal with this suggestion (being safe/reliable, backward-compatible, and intuitive…)
Good question 😉 → it's regular bash, plus some handcrafted support for specific mustaches expressions, as implemented by this code: https://github.com/coq-community/docker-coq-action/blob/v1.2.3/entrypoint.sh#L140-L153 The overall idea being to provide a GitHub container action (docker-coq-action) that works out-of-the-box with docker-coq / opam,
|
I meant there is the information under remarks, and then there is the information at the top. There isn't really a good reason for splitting them up like that, given that both texts are so short, unless the plan is to add substantial more information under remarks. |
probably makes it clearer that this github action main use case is probably building coq projects
just a tip: the table can be added to the other repos and the |
Co-authored-by: Erik Martin-Dorel <[email protected]>
Co-authored-by: Erik Martin-Dorel <[email protected]>
I took the opportunity to refine a few other details in the markdown documentation; will squash-merge now. |
FYI @Bruno-366, this is now done :) |
No description provided.