Skip to content

Commit

Permalink
rename parameter "directory" to "path"
Browse files Browse the repository at this point in the history
  • Loading branch information
kaz-utashiro committed Apr 4, 2022
1 parent a507982 commit e8555f3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ method runs very fast. For packages generate files during
installation, use **timestamp** method, and all files those have newer
timestamp are cached. Files are searched under /etc,
/usr/{bin,sbin,lib,share} and /var/lib directory. Search directries
can be given by **directory** parameter.
can be given by **path** parameter.

Output is same as [`@actions/cache`](https://github.com/actions/cache).

## Usage

```yaml
# inputs:
# tools: { required: true, type: string }
# cache: { required: false, type: string, default: yes }
# key: { required: false, type: string }
# tools: { required: true, type: string }
# cache: { required: false, type: string, default: yes }
# key: { required: false, type: string }
# method: { required: false, type: string, default: package }
# directory: { required: false, type: string,
# default: "/etc /usr/bin /usr/sbin /usr/lib /usr/share /var/lib" }
# path: { required: false, type: string,
# default: "/etc /usr/bin /usr/sbin /usr/lib /usr/share /var/lib" }

- uses: tecoli-com/actions-use-apt-tools@v0
with:
Expand All @@ -54,8 +54,8 @@ Output is same as [`@actions/cache`](https://github.com/actions/cache).
# timestamp: use file's timestamps to check update
method: package

# Search directories with "timestamp" method
directory: ''
# Search path with "timestamp" method
path: ''
```
## Example
Expand All @@ -72,7 +72,7 @@ Output is same as [`@actions/cache`](https://github.com/actions/cache).
For packages which generates additional files other than included in
package during installation, use *timestamp* method. If you know
where they will be placed, provide them by a *directory* parameter.
where they will be placed, provide them by a *path* parameter.
```yaml
- uses: tecoli-com/actions-use-apt-tools@v0
Expand Down
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ inputs:
cache: { required: false, type: string, default: yes }
key: { required: false, type: string }
method: { required: false, type: string, default: package }
directory:
path:
required: false
type: string
default: >-
Expand Down Expand Up @@ -70,12 +70,12 @@ runs:
inputs.method == 'timestamp' &&
steps.setup.outputs.cache != 'no' &&
steps.cache.outputs.cache-hit != 'true'
uses: tecoli-com/actions-install-and-archive@v0
uses: tecoli-com/actions-install-and-archive@v0.3
with:
target: ${{ inputs.tools }}
command: apt-get install -y
archive: ${{ steps.setup.outputs.archive }}
directory: ${{ inputs.directory }}
path: ${{ inputs.path }}
sudo: true

- id: self-install
Expand Down

0 comments on commit e8555f3

Please sign in to comment.