Skip to content

Commit

Permalink
docs: Update the custom_script default and documentation
Browse files Browse the repository at this point in the history
* The "startGroup GroupTitle"/"endGroup" commands allow one to create
  timed foldable sections in the GitHub action logging.
  • Loading branch information
erikmd committed Mar 28, 2020
1 parent c372f83 commit d6ca388
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 12 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,20 @@ Among `"minimal"`, `"4.07-flambda"`, `"4.09-flambda"`.

*Optional* The main script run in the container; may be overridden. Default:

opam config list; opam repo list; opam list
opam pin add -n -y -k path $PACKAGE .
opam update -y
opam install -y -v -j 2 $PACKAGE
opam list
opam remove $PACKAGE
startGroup Print opam config
opam config list; opam repo list; opam list
endGroup
startGroup Fetch dependencies
opam pin add -n -y -k path $PACKAGE .
opam update -y
endGroup
startGroup Build
opam install -y -v -j 2 $PACKAGE
opam list
endGroup
startGroup Uninstallation test
opam remove $PACKAGE
endGroup

*Note: this option is named `custom-script` rather than `script` or
`run` to discourage changing its recommended, default value, while
Expand Down
20 changes: 14 additions & 6 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,20 @@ inputs:
custom_script:
description: 'The main script run in the container; may be overridden.'
default: |
opam config list; opam repo list; opam list
opam pin add -n -y -k path $PACKAGE .
opam update -y
opam install -y -v -j 2 $PACKAGE
opam list
opam remove $PACKAGE
startGroup Print opam config
opam config list; opam repo list; opam list
endGroup
startGroup Fetch dependencies
opam pin add -n -y -k path $PACKAGE .
opam update -y
endGroup
startGroup Build
opam install -y -v -j 2 $PACKAGE
opam list
endGroup
startGroup Uninstallation test
opam remove $PACKAGE
endGroup
runs:
using: 'docker'
image: 'Dockerfile'
Expand Down

0 comments on commit d6ca388

Please sign in to comment.