Skip to content

Commit 86b8ff7

Browse files
authored
docs(ostag): add ostag input to README (#25)
#24 neglected to add the new ostag input to the README
1 parent 3cf72d9 commit 86b8ff7

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ An action to setup MODFLOW 6 and related programs.
99
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1010
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1111

12-
1312
- [Overview](#overview)
1413
- [Usage](#usage)
1514
- [Environment variables](#environment-variables)
@@ -21,6 +20,7 @@ An action to setup MODFLOW 6 and related programs.
2120
- [`tag`](#tag)
2221
- [`subset`](#subset)
2322
- [`cache`](#cache)
23+
- [`ostag`](#ostag)
2424
- [Outputs](#outputs)
2525
- [`cache-hit`](#cache-hit)
2626
- [MODFLOW Resources](#modflow-resources)
@@ -112,6 +112,10 @@ The `cache` input is a boolean that controls whether the action caches the MODFL
112112

113113
**Note:** an [outstanding cache reservation bug in `actions/cache`](https://github.com/actions/cache/issues/144) can cause the cache to [fail to restore while simultaneously rejecting new saves](https://github.com/MODFLOW-USGS/modflow6/actions/runs/3624583228/jobs/6111766806#step:6:152). The [GitHub-endorsed workaround for this issue](https://github.com/actions/cache/issues/144#issuecomment-579323937) is currently to change keys, therefore this action rotates the cache key once daily. Rotating the key daily also allows the action to automatically update versions when they become available, e.g. so workflows can use the most recent nightly build.
114114

115+
### `ostag`
116+
117+
The `ostag` input allows selecting a release by operating system. By default, this is the system the action is running on. Typically one will not need to override this default &mdash; one reason to do so is to select an Intel macOS distribution on an ARM macOS runner.
118+
115119
## Outputs
116120

117121
The action has the following outputs:

0 commit comments

Comments
 (0)