Cookbooks
github
documentation
Archive

Back to resource list

github_archive

Downloads and extracts an archive from a Github repository

Actions

ActionDescription
:extractDownloads and extracts an archive from a Github repository
:deleteDeletes an extracted archive from a Github repository

Properties

NameTypeDefaultDescription
repoStringResource nameRepository org and name
versionStringmasterGit ref (branch, tag, etc)
github_userStringGithub user for authentication
github_tokenStringGithub token for authentication
hostStringhttps://github.comGithub endpoint host
ownerStringOwner for extracted archive
groupStringGroup for extracted archive
extract_toStringPath to extract archive to (required)
forcetrue, falsefalseForce downloading and extracting archive

Examples

github_archive 'elixir-lang/elixir' do
  extract_to '/tmp/test'
end
 
github_archive 'elixir-lang/elixir' do
  extract_to '/tmp/test'
  action :delete
end