Skip to content

Commit

Permalink
docs: last-minute improvements (#62)
Browse files Browse the repository at this point in the history
* docs(README.md): Fix details

* docs: s/docker-coq/docker/ as docker-coq-action is not coq-specific
  • Loading branch information
erikmd authored Aug 11, 2021
1 parent 953471f commit 6c15ead
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ endGroup

Beware that the following script is *buggy*:

```bash
```yaml
script: |
startGroup "Build project"
make -j2 && make test && make install
Expand All @@ -453,7 +453,7 @@ script: |

Because if `make test` fails, it won't make the CI fail.

<details><summary><b>Explanation</b></summary>
<details><summary><b>(Explanation)</b></summary>

This is a typical pitfall that occur *in any shell-based CI platform*
where the [`set -e`](
Expand Down Expand Up @@ -481,7 +481,7 @@ Instead, you should write one of the following variants:

* using semicolons:

```bash
```yaml
script: |
startGroup "Build project"
make -j2 ; make test ; make install
Expand All @@ -490,7 +490,7 @@ Instead, you should write one of the following variants:

* using newlines:

```bash
```yaml
script: |
startGroup "Build project"
make -j2
Expand All @@ -501,7 +501,7 @@ Instead, you should write one of the following variants:

* using `&&` but within a subshell:

```bash
```yaml
script: |
startGroup "Build project"
( make -j2 && make test && make install )
Expand Down
2 changes: 1 addition & 1 deletion entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ if test -z "$INPUT_CUSTOM_SCRIPT_EXPANDED"; then
exit 1
fi

startGroup "Pull docker-coq image"
startGroup "Pull docker image"

echo COQ_IMAGE="$COQ_IMAGE"
docker pull "$COQ_IMAGE"
Expand Down

0 comments on commit 6c15ead

Please sign in to comment.