Skip to content
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

Update README with required Chef version #271

Merged
merged 2 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This file is used to list changes made in each version of the ark cookbook.

## Unreleased

- Update README

## 6.0.25 - *2023-09-28*

## 6.0.24 - *2023-09-04*
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Should work on common Unix/Linux systems with typical userland utilities like ta

### Chef

- Chef 14+
- Chef 15.3+

### Cookbooks

Expand Down Expand Up @@ -87,22 +87,22 @@ Customize the attributes to suit site specific conventions and defaults.
- `:setup_py_build`: runs the command "python setup.py build" in the extracted directory
- `:setup_py_install`: runs the command "python setup.py install" in the extracted directory

### :cherry_pick
### Action: cherry_pick

Extract a specified file from an archive and places in specified path.

#### Relevant Attribute Parameters for :cherry_pick
#### Parameters for `cherry_pick`

- `path`: directory to place file in.
- `creates`: specific file to cherry-pick.

### :dump
### Action: dump

Strips all directories from the archive and dumps the contained files into a specified path.

NOTE: This currently only works for zip archives

#### Attribute Parameters for :dump
#### Parameters for :dump

- `path`: path to dump files to.
- `mode`: file mode for `app_home`, as an integer.
Expand All @@ -111,11 +111,11 @@ NOTE: This currently only works for zip archives

- `creates`: if you are appending files to a given directory, ark needs a condition to test whether the file has already been extracted. You can specify with creates, a file whose existence indicates the ark has previously been extracted and does not need to be extracted again.

### :put
### Action: put

Extract the archive to a specified path, does not create any symbolic links.

#### Attribute Parameters for :put
#### Parameters for :put

- `path`: path to extract to.

Expand Down